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

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

Resource Profile: Patient: obligations

This profile defines obligations for a human Patient in FHIR for the purpose of this guide.

Usages:

• Use this Profile: Bundle: obligations
• Refer to this Profile: CarePlan: obligations, Composition: obligations, DeviceUseStatement: obligations, Encounter: obligations... Show 2 more, MedicationAdministration: obligations and MedicationDispense: obligations

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
Patient		0..*	PatientEuCore	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	AddressEu	Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	O This element has obligations. Σ This element is included in summaries.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	O This element has obligations. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1 Obligations Actor SHALL:able-to-populate Producer
Patient.name.use	?! This element is a modifier element. O This element has obligations. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations. Σ This element is included in summaries.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations. Σ This element is included in summaries.	0..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations. Σ This element is included in summaries.	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:able-to-populate Producer
Patient.gender	O This element has obligations. Σ This element is included in summaries.	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations. Σ This element is included in summaries.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())
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    Filter: Bindings Constraints Obligations
Patient			PatientEuCore
Patient.identifier	O This element has obligations.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.name	O This element has obligations.	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:able-to-populate Producer
Patient.name.use	O This element has obligations.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations.	0..1	string	Family name. Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:able-to-populate Producer
Patient.gender	O This element has obligations.	0..1	code	Administrative Gender Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientEuCore	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	AddressEu	Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	O This element has obligations. Σ This element is included in summaries.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	O This element has obligations. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1 Obligations Actor SHALL:able-to-populate Producer
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. O This element has obligations. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations. Σ This element is included in summaries.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations. Σ This element is included in summaries.	0..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations. Σ This element is included in summaries.	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:able-to-populate Producer
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the patient
Patient.gender	O This element has obligations. Σ This element is included in summaries.	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations. Σ This element is included in summaries.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	AddressEu	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital status Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	Contact name
Patient.contact.telecom		0..*	ContactPoint	Contact details for the person
Patient.contact.address		0..1	AddressEu	Contact person address
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider.
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())
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

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientEuCore	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	AddressEu	Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	O This element has obligations. Σ This element is included in summaries.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	O This element has obligations. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1 Obligations Actor SHALL:able-to-populate Producer
Patient.name.use	?! This element is a modifier element. O This element has obligations. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations. Σ This element is included in summaries.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations. Σ This element is included in summaries.	0..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations. Σ This element is included in summaries.	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:able-to-populate Producer
Patient.gender	O This element has obligations. Σ This element is included in summaries.	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations. Σ This element is included in summaries.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())
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    Filter: Bindings Constraints Obligations
Patient			PatientEuCore
Patient.identifier	O This element has obligations.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.name	O This element has obligations.	1..*	HumanName	A name associated with the patient Obligations Actor SHALL:able-to-populate Producer
Patient.name.use	O This element has obligations.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations.	0..1	string	Family name. Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:able-to-populate Producer
Patient.gender	O This element has obligations.	0..1	code	Administrative Gender Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientEuCore	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	AddressEu	Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	O This element has obligations. Σ This element is included in summaries.	0..*	Identifier	Patient identifiers Obligations Actor SHALL:able-to-populate Producer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	O This element has obligations. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1 Obligations Actor SHALL:able-to-populate Producer
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. O This element has obligations. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.text	O This element has obligations. Σ This element is included in summaries.	0..1	string	Text representation of the full name. Obligations Actor SHOULD:able-to-populate Producer
Patient.name.family	O This element has obligations. Σ This element is included in summaries.	0..1	string	Family name. Example spanish: Valero Iglesias Obligations Actor SHALL:able-to-populate Producer
Patient.name.given	O This element has obligations. Σ This element is included in summaries.	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:able-to-populate Producer
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the patient
Patient.gender	O This element has obligations. Σ This element is included in summaries.	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHOULD:able-to-populate Producer
Patient.birthDate	O This element has obligations. Σ This element is included in summaries.	1..1	date	The date of birth for the individual Obligations Actor SHOULD:able-to-populate Producer
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	AddressEu	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital status Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	Contact name
Patient.contact.telecom		0..*	ContactPoint	Contact details for the person
Patient.contact.address		0..1	AddressEu	Contact person address
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider.
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())
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

Maturity: 0

Other representations of profile: CSV, Excel, Schematron