HL7 Laboratory Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-lab-rep-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: Patient Obligations

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

Usage:

• Examples for this Resource Profile: Patient/pat-lab-example

Formal Views of Profile Content

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

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

This structure is derived from PatientUvLab

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
identifier	O	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
name
text	O	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	O	0..1	string	Family name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	O	0..*	string	Given names. Includes middle names Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	O	0..1	code	Administrative Gender Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	O	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
address	O	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
sex-for-clinical-use		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	ΣC	1..*	HumanName	A name associated with the patient uv-lab-pat-1: given, family, text or a data-absent-reason extension SHALL be present
Slices for extension				Content/Rules for all slices
name-absent-reason		0..*	code	Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	OΣ	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	OΣ	0..1	string	Family name Example spanish: Valero Iglesias Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	OΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	OΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
uv-lab-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()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
sex-for-clinical-use		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	ΣC	1..*	HumanName	A name associated with the patient uv-lab-pat-1: given, family, text or a data-absent-reason extension SHALL be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
name-absent-reason		0..*	code	Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	OΣ	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	OΣ	0..1	string	Family name Example spanish: Valero Iglesias Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	OΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	OΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	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	Relationship between a patient and a contact person for that patient Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Contact Address
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from PatientUvLab

Summary

Maturity: 0

Differential View

This structure is derived from PatientUvLab

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
identifier	O	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
name
text	O	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	O	0..1	string	Family name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	O	0..*	string	Given names. Includes middle names Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	O	0..1	code	Administrative Gender Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	O	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
address	O	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
sex-for-clinical-use		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	ΣC	1..*	HumanName	A name associated with the patient uv-lab-pat-1: given, family, text or a data-absent-reason extension SHALL be present
Slices for extension				Content/Rules for all slices
name-absent-reason		0..*	code	Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	OΣ	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	OΣ	0..1	string	Family name Example spanish: Valero Iglesias Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	OΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	OΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
uv-lab-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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvLab	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
sex-for-clinical-use		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	Patient identifiers Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	ΣC	1..*	HumanName	A name associated with the patient uv-lab-pat-1: given, family, text or a data-absent-reason extension SHALL be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
name-absent-reason		0..*	code	Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	OΣ	0..1	string	Text representation of the full name. Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
family	OΣ	0..1	string	Family name Example spanish: Valero Iglesias Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
given	OΣ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
gender	OΣ	0..1	code	Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	Address	An address for the individual Obligations Actor SHALL:handle SHALL:handle SHALL:able-to-populate
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	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	Relationship between a patient and a contact person for that patient Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Contact Address
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	O	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated care provider Obligations Actor SHALL:handle SHALL:handle SHOULD:able-to-populate
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from PatientUvLab

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron