HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Imaging Patient

Human patient representing the subject of a medical imaging study for the scope of the HL7 Europe project.

Usage:

• Refer to this Resource Profile: Imaging Composition, Coverage information, Imaging Diagnostic Report, Finding... Show 6 more, ImagingStudy, Impression, Imaging Key Image Document Reference, Medication Administration, Imaging Order and Recommended CarePlan

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension ele-1: All FHIR elements must have a @value or children
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SOΣ	0..*	Identifier	Patient identifiers ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SOΣC	1..*	HumanNameEu	A name associated with the patient ele-1: All FHIR elements must have a @value or children eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present Obligations Actor SHALL:populate-if-known IM Producer
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SOΣ	0..1	string	Family name. ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias Example spanish: Valero Iglesias Obligations Actor SHALL:populate-if-known IM Producer
Slices for extension				Content/Rules for all slices
extension:fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
extension:mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
given	SOΣ	0..*	string	Given names. Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:populate-if-known IM Producer
telecom	SOΣ	0..*	ContactPoint	A contact detail for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
gender	SOΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SOΣ	1..1	date	The date of birth for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
Slices for extension				Content/Rules for all slices
extension:dob-absent-reason		0..1	code	Reason for not providing the Date of Birth. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	AddressEu	An address for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
eu-pat-1	error	Patient.name	given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from PatientEuCore

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im
meta
security	S	0..*	Coding	Security Labels applied to this resource
language	S	0..1	code	Language of the resource content
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
identifier	SO	0..*	Identifier	Patient identifiers Obligations Actor SHALL:populate-if-known IM Producer
name	SO	1..*	HumanNameEu	A name associated with the patient Obligations Actor SHALL:populate-if-known IM Producer
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
family	SO	0..1	string	Family name. Obligations Actor SHALL:populate-if-known IM Producer
given	SO	0..*	string	Given names. Includes middle names Obligations Actor SHALL:populate-if-known IM Producer
telecom	SO	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:populate-if-known IM Producer
gender	SO	0..1	code	Administrative Gender Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SO	1..1	date	The date of birth for the patient Obligations Actor SHALL:populate-if-known IM Producer
address	SO	0..*	AddressEu	An address for the individual Obligations Actor SHALL:populate-if-known IM Producer
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SOΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:populate-if-known IM Producer
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanNameEu	A name associated with the patient eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	id	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..*	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!SΣ	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	SOΣ	0..1	string	Family name. Example spanish name: Valero Iglesias Example spanish: Valero Iglesias Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
extension:mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
value		0..1	string	Primitive value for string Max Length:1048576
given	SOΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:populate-if-known IM Producer
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	SOΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:populate-if-known IM Producer
gender	SOΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SOΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dob-absent-reason		0..1	code	Reason for not providing the Date of Birth. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:populate-if-known IM Producer
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (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	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
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
relationship		0..*	CodeableConceptIPS	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	C	0..1	HumanNameEu	Contact name
telecom	C	0..*	ContactPoint	Contact details for the person
address	C	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	Communication language Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base))	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 a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.maritalStatus	extensible	MaritalStatusCodes 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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
eu-pat-1	error	Patient.name	given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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()

This structure is derived from PatientEuCore

Summary

Mandatory: 2 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/individual-genderIdentity

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension ele-1: All FHIR elements must have a @value or children
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SOΣ	0..*	Identifier	Patient identifiers ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SOΣC	1..*	HumanNameEu	A name associated with the patient ele-1: All FHIR elements must have a @value or children eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present Obligations Actor SHALL:populate-if-known IM Producer
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SOΣ	0..1	string	Family name. ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias Example spanish: Valero Iglesias Obligations Actor SHALL:populate-if-known IM Producer
Slices for extension				Content/Rules for all slices
extension:fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
extension:mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
given	SOΣ	0..*	string	Given names. Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:populate-if-known IM Producer
telecom	SOΣ	0..*	ContactPoint	A contact detail for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
gender	SOΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SOΣ	1..1	date	The date of birth for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
Slices for extension				Content/Rules for all slices
extension:dob-absent-reason		0..1	code	Reason for not providing the Date of Birth. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	AddressEu	An address for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
eu-pat-1	error	Patient.name	given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from PatientEuCore

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im
meta
security	S	0..*	Coding	Security Labels applied to this resource
language	S	0..1	code	Language of the resource content
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
identifier	SO	0..*	Identifier	Patient identifiers Obligations Actor SHALL:populate-if-known IM Producer
name	SO	1..*	HumanNameEu	A name associated with the patient Obligations Actor SHALL:populate-if-known IM Producer
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
family	SO	0..1	string	Family name. Obligations Actor SHALL:populate-if-known IM Producer
given	SO	0..*	string	Given names. Includes middle names Obligations Actor SHALL:populate-if-known IM Producer
telecom	SO	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:populate-if-known IM Producer
gender	SO	0..1	code	Administrative Gender Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SO	1..1	date	The date of birth for the patient Obligations Actor SHALL:populate-if-known IM Producer
address	SO	0..*	AddressEu	An address for the individual Obligations Actor SHALL:populate-if-known IM Producer
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientEuCore	Patient Im
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:genderIdentity	S	1..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SOΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:populate-if-known IM Producer
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanNameEu	A name associated with the patient eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	id	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..*	code	Reason for not providing the name. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!SΣ	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	SOΣ	0..1	string	Family name. Example spanish name: Valero Iglesias Example spanish: Valero Iglesias Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
extension:mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
value		0..1	string	Primitive value for string Max Length:1048576
given	SOΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:populate-if-known IM Producer
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	SOΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:populate-if-known IM Producer
gender	SOΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known IM Producer
birthDate	SOΣ	1..1	date	The date of birth for the patient Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dob-absent-reason		0..1	code	Reason for not providing the Date of Birth. URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:populate-if-known IM Producer
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (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	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
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
relationship		0..*	CodeableConceptIPS	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	C	0..1	HumanNameEu	Contact name
telecom	C	0..*	ContactPoint	Contact details for the person
address	C	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	Communication language Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base))	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 a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.maritalStatus	extensible	MaritalStatusCodes 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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
eu-pat-1	error	Patient.name	given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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()

This structure is derived from PatientEuCore

Summary

Mandatory: 2 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/individual-genderIdentity

Maturity: 1

Other representations of profile: CSV, Excel, Schematron