This page is part of the HL7 Europe Laboratory Report (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: Patient: Animal

This profile defines how to represent an Animal as subject of care in FHIR for the purpose of this guide. This profile SHALL NOT be used to identify the species when a specimen is collected from an animal. Animal Specimen are represented by AnimalSpecimenEuLab.

Usages:

• Examples for this Profile: Patient/Patient-animal-example

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..*	Patient	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		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.url		1..1	uri	"species"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed		0..1	Extension	The animal breed. E.g. Poodle, Angus.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.url		1..1	uri	"breed"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.value[x]		1..1	CodeableConcept	Value of extension Binding: AnimalBreeds (example): The breed of an animal.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus		0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.url		1..1	uri	"genderStatus"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.value[x]		1..1	CodeableConcept	Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs.
Patient.Slices for extension.extension:patient-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
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.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.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	This IG
Patient.extension:patient-animal.​extension:breed.value[x]	Base	example	Animal breeds	📍4.0.1	FHIR Std.
Patient.extension:patient-animal.​extension:genderStatus.​value[x]	Base	example	Gender status	📍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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.telecom		0..0		Use contact.telecom
Patient.maritalStatus		0..0		Marital (civil) status of a patient
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	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
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		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.url		1..1	uri	"species"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed		0..1	Extension	The animal breed. E.g. Poodle, Angus.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.url		1..1	uri	"breed"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.value[x]		1..1	CodeableConcept	Value of extension Binding: AnimalBreeds (example): The breed of an animal.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus		0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.url		1..1	uri	"genderStatus"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.value[x]		1..1	CodeableConcept	Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs.
Patient.Slices for extension.extension:patient-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
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	Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
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..*	Address	An address for the individual
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	The kind of 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	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
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	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
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.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	This IG
Patient.extension:patient-animal.​extension:breed.value[x]	Base	example	Animal breeds	📍4.0.1	FHIR Std.
Patient.extension:patient-animal.​extension:genderStatus.​value[x]	Base	example	Gender status	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍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())
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 Patient

Summary

Mandatory: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-animal|5.3.0
• http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender|5.3.0

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	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		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.url		1..1	uri	"species"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed		0..1	Extension	The animal breed. E.g. Poodle, Angus.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.url		1..1	uri	"breed"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.value[x]		1..1	CodeableConcept	Value of extension Binding: AnimalBreeds (example): The breed of an animal.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus		0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.url		1..1	uri	"genderStatus"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.value[x]		1..1	CodeableConcept	Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs.
Patient.Slices for extension.extension:patient-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
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.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.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	This IG
Patient.extension:patient-animal.​extension:breed.value[x]	Base	example	Animal breeds	📍4.0.1	FHIR Std.
Patient.extension:patient-animal.​extension:genderStatus.​value[x]	Base	example	Gender status	📍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())
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 Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.telecom		0..0		Use contact.telecom
Patient.maritalStatus		0..0		Marital (civil) status of a patient
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	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		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patient-animal		1..1	(Complex)	This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal
Patient.Slices for extension.extension:patient-animal.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species		1..1	Extension	The animal species. E.g. Dog, Cow.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.url		1..1	uri	"species"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:species.value[x]		1..1	CodeableConcept	Value of extension Binding: Types of species (example)
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed		0..1	Extension	The animal breed. E.g. Poodle, Angus.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.url		1..1	uri	"breed"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:breed.value[x]		1..1	CodeableConcept	Value of extension Binding: AnimalBreeds (example): The breed of an animal.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus		0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.url		1..1	uri	"genderStatus"
Patient.Slices for extension.extension:patient-animal.Slices for extension.extension:genderStatus.value[x]		1..1	CodeableConcept	Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs.
Patient.Slices for extension.extension:patient-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
Patient.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
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	Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
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..*	Address	An address for the individual
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	The kind of 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	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
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	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
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.extension:patient-animal.​extension:species.value[x]	Base	example	Types of species	📦2.1.0	This IG
Patient.extension:patient-animal.​extension:breed.value[x]	Base	example	Animal breeds	📍4.0.1	FHIR Std.
Patient.extension:patient-animal.​extension:genderStatus.​value[x]	Base	example	Gender status	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍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())
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 Patient

Summary

Mandatory: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-animal|5.3.0
• http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender|5.3.0

Maturity: 2

Other representations of profile: CSV, Excel, Schematron