Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient (EU core)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	OΣ	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
Slices for extension				Content/Rules for all slices
extension:name-absent-reason		0..1	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
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	OΣ	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	OΣ	1..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle HDR Handler
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	OΣ	0..1	code	The gender of the patient used for administrative purposes. Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	OΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
contact	OC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 Obligations Actor SHALL:handle HDR Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	OΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	OΣ	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 Obligations Actor SHALL:handle HDR Handler
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient	This profile also imposes the profile Patient (EU core)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
identifier	O	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
name	O	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
Slices for extension				Content/Rules for all slices
extension:name-absent-reason		0..*	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
text		0..1	string	Text representation of the full name.
family	O	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	O	1..*	string	Given names. Includes middle names Obligations Actor SHALL:handle HDR Handler
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	O	0..1	code	The gender of the patient used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	O	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
address	O	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
country
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	SCCoding(5.2.0)	code for string
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
contact	O	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Obligations Actor SHALL:handle HDR Handler
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
family	O	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	O	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:handle HDR Handler
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient (EU core)
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	OΣ	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
id		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
extension:name-absent-reason		0..1	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
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	OΣ	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	OΣ	1..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	OΣ	0..1	code	The gender of the patient used for administrative purposes. Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	OΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
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	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	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	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)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	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	OC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 Obligations Actor SHALL:handle HDR Handler
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
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	OΣ	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 Obligations Actor SHALL:handle HDR Handler
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	Contact details for the person
address		0..1	AddressEu	Contact person address
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	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		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

• Address (EU) (http://hl7.eu/fhir/laboratory/StructureDefinition/Address-eu)
• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.contact.relationship

Maturity: 1

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient (EU core)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	OΣ	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
Slices for extension				Content/Rules for all slices
extension:name-absent-reason		0..1	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
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	OΣ	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	OΣ	1..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle HDR Handler
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	OΣ	0..1	code	The gender of the patient used for administrative purposes. Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	OΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
contact	OC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 Obligations Actor SHALL:handle HDR Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	OΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	OΣ	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 Obligations Actor SHALL:handle HDR Handler
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient	This profile also imposes the profile Patient (EU core)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
identifier	O	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
name	O	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
Slices for extension				Content/Rules for all slices
extension:name-absent-reason		0..*	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
text		0..1	string	Text representation of the full name.
family	O	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	O	1..*	string	Given names. Includes middle names Obligations Actor SHALL:handle HDR Handler
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	O	0..1	code	The gender of the patient used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	O	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
address	O	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
country
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	SCCoding(5.2.0)	code for string
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
contact	O	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Obligations Actor SHALL:handle HDR Handler
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
family	O	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	O	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:handle HDR Handler
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient (EU core)
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers. Obligations Actor SHALL:handle HDR Handler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	OΣ	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:handle HDR Handler
id		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
extension:name-absent-reason		0..1	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
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	OΣ	1..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:handle HDR Handler
given	OΣ	1..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle HDR Handler
gender	OΣ	0..1	code	The gender of the patient used for administrative purposes. Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle HDR Handler
birthDate	OΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:handle HDR Handler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle HDR Handler
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	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	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	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)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	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	OC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 Obligations Actor SHALL:handle HDR Handler
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
Slices for relationship	O	0..*	CodeableConceptIPS	Type of contact relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Obligations Actor SHALL:handle HDR Handler
relationship:role		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Role Class (required)
relationship:relationship		0..1	CodeableConcept	The kind of relationship Binding: eHDSI Personal Relationship (required)
name	O	0..1	HumanName	Contact name Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle HDR Handler
given	OΣ	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 Obligations Actor SHALL:handle HDR Handler
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	Contact details for the person
address		0..1	AddressEu	Contact person address
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	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		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship:role	required	EHDSIRoleClass http://terminology.ehdsi.eu/ValueSet/eHDSIRoleClass From this IG
Patient.contact.relationship:relationship	required	EHDSIPersonalRelationship http://terminology.ehdsi.eu/ValueSet/eHDSIPersonalRelationship From this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

• Address (EU) (http://hl7.eu/fhir/laboratory/StructureDefinition/Address-eu)
• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.contact.relationship

Maturity: 1