HL7 PT FHIR Implementation Guide: Visita do Utente, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/workflow-ep-ig/tree/master and changes regularly. See the Directory of published versions

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

Resource Profile: PT_Patient

Representa a entidade central de um sistema de saúde, referindo-se a cada pessoa que recebe ou tem potencial para receber cuidados clínicos dentro de uma instituição de saúde. Armazena as principais informações demográficas e clínicas do utente. Este registo consolidado serve como uma referência única que facilita o acesso rápido e preciso a dados importantes do utente, contribuindo para uma abordagem personalizada e centrada no indivíduo e proporcionando uma visão integrada e holística que suporta o planeamento de cuidados, decisões clínicas fundamentadas e a melhoria contínua dos serviços de saúde ao longo da vida do utente.

Usage:

• Refer to this Resource Profile: PT_Encounter

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:code		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"code"
extension:period		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"period"
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality"
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Example Patient Gender: Male
birthDate	Σ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Example Patient death indicator: false
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Example Date and time of patient's death: 2021-12-31
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient
meta		0..1	Meta	Metadata about the resource
id		0..0
versionId		0..0
lastUpdated		0..1	instant	When the resource version last changed
source		0..0
profile		0..0
security		0..0
tag		0..0
implicitRules		0..0
language		0..0
text		0..0
contained		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
identifier
id		0..0
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.
id		0..0
coding
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Code Type: HC
display		0..1	string	Representation defined by the system Example Code Type Description: Health Card Number
userSelected		0..0
text		0..1	string	Plain text representation of the concept Example ID number code used: RNU
system		0..1	uri	The namespace for the identifier value Example Coding System: https://www.spms.min-saude.pt/rnu/
value		0..1	string	The value that is unique Example Identification number: 999999999
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary Example Document validity start date: 2021-01-01
end		0..1	dateTime	End time with inclusive boundary, if not ongoing Example Document expiration date: 2021-12-31
assigner		0..1	Reference(PT_Organization)	Organization that issued id (may be just text)
id		0..0
reference		0..0
type		0..0
identifier		0..0
display		0..1	string	Text alternative for the resource
name
id		0..0
use		0..1	code	usual | official | temp | nickname | anonymous | old | maiden Example Name Type Code: official
text		0..1	string	Text representation of the full name Example Full name: John Anthony Doe
family		0..1	string	Family name (often called 'Surname') Example Last Name: Doe
Slices for given		0..*	string	Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:value
given:firstName		0..*	string	Given names (not always 'first'). Includes middle names Example First Name: John
given:middleName		0..*	string	Given names (not always 'first'). Includes middle names Example Middle Name: Anthony
prefix		0..0
suffix		0..0
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary Example Name use start date: 2021-01-01
end		0..1	dateTime	End time with inclusive boundary, if not ongoing Example End date of name usage: 2021-12-31
telecom
id		0..0
system		0..1	code	phone | fax | email | pager | url | sms | other Example Contact type: phone
value		0..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Example Contact Usage: home
period		0..0
gender		0..1	code	male | female | other | unknown Example Patient Gender: Male
birthDate		0..1	date	The date of birth for the individual Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not Example Patient death indicator: false
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not Example Date and time of patient's death: 2021-12-31
address
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	CodeableConcept	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
use		0..1	code	home | work | temp | old | billing - purpose of this address Example Type of residence: home
type		0..0
text		0..0
line		0..*	string	Street name, number, direction & P.O. Box etc. Example General: RUA DA BURAQUEIRA N\XBA\11
city		0..1	string	Name of city, town etc. Example City: ABRUNHEIRA
district		0..1	string	District name (aka county) Example District/County: MONTEMOR O VELHO
state		0..1	string	Sub-unit of country (abbreviations ok) Example State: COIMBRA
postalCode		0..1	string	Postal code for area Example Postal Code: 3140-015
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes Example Country: PT
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus
id		0..0
coding
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Patient Marital Status Code: M
display		0..1	string	Representation defined by the system Example Description of the patient's marital status: Married
userSelected		0..0
text		0..0
Slices for multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo		0..0
contact
id		0..0
relationship
id		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
userSelected		0..0
text		0..1	string	Plain text representation of the concept
name
id		0..0
text		0..1	string	Text representation of the full name Example Full Name: Mary Doe
family		0..1	string	Family name (often called 'Surname') Example Last Name: Doe
given		0..*	string	Given names (not always 'first'). Includes middle names Example First Name: Mary
prefix		0..0
suffix		0..0
period		0..0
telecom
id		0..0
system		0..1	code	phone | fax | email | pager | url | sms | other Example Contact Type: phone
value		0..1	string	The actual contact point details Example Telephone contact: 999999999
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Example Contact Usage: home
period		0..0
address
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
value[x]		0..1	CodeableConcept	Value of extension
type		0..0
text		0..0
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
district		0..1	string	District name (aka county)
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	Postal code for area
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
gender		0..1	code	male | female | other | unknown Example Gender: Female
organization		0..0
period		0..0
communication
id		0..0
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
id		0..0
coding
id		0..0
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Code Primary Language: pt
display		0..1	string	Representation defined by the system Example Primary Language Display: Portuguese
userSelected		0..0
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider
managingOrganization		0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
Patient.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.contact.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
lastUpdated	Σ	0..1	instant	When the resource version last changed
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Iso3166-1-2 (extensible): This value set defines the ISO 3166 Part 1 2-letter codes
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Iso3166-1-2 (extensible): This value set defines the ISO 3166 Part 1 2-letter codes
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example Patient Nationality - Coding System: urn:iso:std:iso:3166
code	Σ	0..1	code	Symbol in syntax defined by the system Example Patient Nationality - Code: PT
display	Σ	0..1	string	Representation defined by the system Example Patient's nationality - Name: Portuguesa
extension:period		0..1	Extension	Extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"period"
value[x]		0..1	Period	Value of extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality"
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Code Type: HC
display	Σ	0..1	string	Representation defined by the system Example Code Type Description: Health Card Number
text	Σ	0..1	string	Plain text representation of the concept Example ID number code used: RNU
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example Coding System: https://www.spms.min-saude.pt/rnu/
value	Σ	0..1	string	The value that is unique Example General: 123456 Example Identification number: 999999999
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Example Document validity start date: 2021-01-01
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Example Document expiration date: 2021-12-31
assigner	Σ	0..1	Reference(PT_Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Example Name Type Code: official
text	Σ	0..1	string	Text representation of the full name Example Full name: John Anthony Doe
family	Σ	0..1	string	Family name (often called 'Surname') Example Last Name: Doe
Slices for given	Σ	0..*	string	Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:value This repeating element order: Given Names appear in the correct order for presenting the name
given:firstName	Σ	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 Example First Name: John
given:middleName	Σ	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 Example Middle Name: Anthony
period	Σ	0..1	Period	Time period when name was/is in use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Example Name use start date: 2021-01-01
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Example End date of name usage: 2021-12-31
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Example Contact type: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Example Contact Usage: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example Patient Gender: Male
birthDate	Σ	0..1	date	The date of birth for the individual Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not Example Patient death indicator: false
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Example Date and time of patient's death: 2021-12-31
address	Σ	0..*	Address	An address for the individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	CodeableConcept	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home Example Type of residence: home
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: RUA DA BURAQUEIRA N\XBA\11
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example City: ABRUNHEIRA
district	Σ	0..1	string	District name (aka county) Example General: Madison Example District/County: MONTEMOR O VELHO
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Example State: COIMBRA
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example Postal Code: 3140-015
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes Example Country: PT
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Patient Marital Status Code: M
display	Σ	0..1	string	Representation defined by the system Example Description of the patient's marital status: Married
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name Example Full Name: Mary Doe
family	Σ	0..1	string	Family name (often called 'Surname') Example Last Name: Doe
given	Σ	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 Example First Name: Mary
telecom		0..*	ContactPoint	A contact detail for the person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Example Contact Type: phone
value	Σ	0..1	string	The actual contact point details Example Telephone contact: 999999999
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Example Contact Usage: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
address		0..1	Address	Address for the contact person
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Address"
value[x]		0..1	CodeableConcept	Value of extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example Coding System: http://ine.pt
code	Σ	0..1	code	Symbol in syntax defined by the system Example Parish code: 061015
display	Σ	0..1	string	Representation defined by the system Example Description of the parish: União das Freguesias de Abrunheira, Verride e Vila Nova da Barca
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example Gender: Female
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Code Primary Language: pt
display	Σ	0..1	string	Representation defined by the system Example Primary Language Display: Portuguese
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.extension:Nationality.extension:code.value[x]	extensible	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.extension:Nationality.extension:code.value[x].coding	extensible	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from Patient

Summary

Prohibited: 58 elements

Structures

This structure refers to these other structures:

• PT_Organization (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTOrganization)
• PT_Practitioner (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitioner)
• PT_PractitionerRole (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitionerRole)

Extensions

This structure refers to these extensions:

• https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
• https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
• https://hl7.pt/fhir/patient-visit/StructureDefinition/Address

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.name.given
• The element 1 is sliced based on the value of Patient.deceased[x]
• The element 1 is sliced based on the value of Patient.multipleBirth[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:code		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"code"
extension:period		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"period"
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality"
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Example Patient Gender: Male
birthDate	Σ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Example Patient death indicator: false
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Example Date and time of patient's death: 2021-12-31
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient
meta		0..1	Meta	Metadata about the resource
id		0..0
versionId		0..0
lastUpdated		0..1	instant	When the resource version last changed
source		0..0
profile		0..0
security		0..0
tag		0..0
implicitRules		0..0
language		0..0
text		0..0
contained		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
identifier
id		0..0
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.
id		0..0
coding
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Code Type: HC
display		0..1	string	Representation defined by the system Example Code Type Description: Health Card Number
userSelected		0..0
text		0..1	string	Plain text representation of the concept Example ID number code used: RNU
system		0..1	uri	The namespace for the identifier value Example Coding System: https://www.spms.min-saude.pt/rnu/
value		0..1	string	The value that is unique Example Identification number: 999999999
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary Example Document validity start date: 2021-01-01
end		0..1	dateTime	End time with inclusive boundary, if not ongoing Example Document expiration date: 2021-12-31
assigner		0..1	Reference(PT_Organization)	Organization that issued id (may be just text)
id		0..0
reference		0..0
type		0..0
identifier		0..0
display		0..1	string	Text alternative for the resource
name
id		0..0
use		0..1	code	usual | official | temp | nickname | anonymous | old | maiden Example Name Type Code: official
text		0..1	string	Text representation of the full name Example Full name: John Anthony Doe
family		0..1	string	Family name (often called 'Surname') Example Last Name: Doe
Slices for given		0..*	string	Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:value
given:firstName		0..*	string	Given names (not always 'first'). Includes middle names Example First Name: John
given:middleName		0..*	string	Given names (not always 'first'). Includes middle names Example Middle Name: Anthony
prefix		0..0
suffix		0..0
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary Example Name use start date: 2021-01-01
end		0..1	dateTime	End time with inclusive boundary, if not ongoing Example End date of name usage: 2021-12-31
telecom
id		0..0
system		0..1	code	phone | fax | email | pager | url | sms | other Example Contact type: phone
value		0..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Example Contact Usage: home
period		0..0
gender		0..1	code	male | female | other | unknown Example Patient Gender: Male
birthDate		0..1	date	The date of birth for the individual Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not Example Patient death indicator: false
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not Example Date and time of patient's death: 2021-12-31
address
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	CodeableConcept	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
use		0..1	code	home | work | temp | old | billing - purpose of this address Example Type of residence: home
type		0..0
text		0..0
line		0..*	string	Street name, number, direction & P.O. Box etc. Example General: RUA DA BURAQUEIRA N\XBA\11
city		0..1	string	Name of city, town etc. Example City: ABRUNHEIRA
district		0..1	string	District name (aka county) Example District/County: MONTEMOR O VELHO
state		0..1	string	Sub-unit of country (abbreviations ok) Example State: COIMBRA
postalCode		0..1	string	Postal code for area Example Postal Code: 3140-015
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes Example Country: PT
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus
id		0..0
coding
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Patient Marital Status Code: M
display		0..1	string	Representation defined by the system Example Description of the patient's marital status: Married
userSelected		0..0
text		0..0
Slices for multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo		0..0
contact
id		0..0
relationship
id		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
system		0..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
userSelected		0..0
text		0..1	string	Plain text representation of the concept
name
id		0..0
text		0..1	string	Text representation of the full name Example Full Name: Mary Doe
family		0..1	string	Family name (often called 'Surname') Example Last Name: Doe
given		0..*	string	Given names (not always 'first'). Includes middle names Example First Name: Mary
prefix		0..0
suffix		0..0
period		0..0
telecom
id		0..0
system		0..1	code	phone | fax | email | pager | url | sms | other Example Contact Type: phone
value		0..1	string	The actual contact point details Example Telephone contact: 999999999
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Example Contact Usage: home
period		0..0
address
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
value[x]		0..1	CodeableConcept	Value of extension
type		0..0
text		0..0
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
district		0..1	string	District name (aka county)
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	Postal code for area
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes
period
id		0..0
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
gender		0..1	code	male | female | other | unknown Example Gender: Female
organization		0..0
period		0..0
communication
id		0..0
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
id		0..0
coding
id		0..0
version		0..0
code		0..1	code	Symbol in syntax defined by the system Example Code Primary Language: pt
display		0..1	string	Representation defined by the system Example Primary Language Display: Portuguese
userSelected		0..0
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider
managingOrganization		0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
Patient.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.contact.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
lastUpdated	Σ	0..1	instant	When the resource version last changed
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Nationality		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Iso3166-1-2 (extensible): This value set defines the ISO 3166 Part 1 2-letter codes
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Iso3166-1-2 (extensible): This value set defines the ISO 3166 Part 1 2-letter codes
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example Patient Nationality - Coding System: urn:iso:std:iso:3166
code	Σ	0..1	code	Symbol in syntax defined by the system Example Patient Nationality - Code: PT
display	Σ	0..1	string	Representation defined by the system Example Patient's nationality - Name: Portuguesa
extension:period		0..1	Extension	Extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"period"
value[x]		0..1	Period	Value of extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality"
BirthPlace		0..1	Address	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Code Type: HC
display	Σ	0..1	string	Representation defined by the system Example Code Type Description: Health Card Number
text	Σ	0..1	string	Plain text representation of the concept Example ID number code used: RNU
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example Coding System: https://www.spms.min-saude.pt/rnu/
value	Σ	0..1	string	The value that is unique Example General: 123456 Example Identification number: 999999999
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Example Document validity start date: 2021-01-01
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Example Document expiration date: 2021-12-31
assigner	Σ	0..1	Reference(PT_Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Example Name Type Code: official
text	Σ	0..1	string	Text representation of the full name Example Full name: John Anthony Doe
family	Σ	0..1	string	Family name (often called 'Surname') Example Last Name: Doe
Slices for given	Σ	0..*	string	Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:value This repeating element order: Given Names appear in the correct order for presenting the name
given:firstName	Σ	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 Example First Name: John
given:middleName	Σ	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 Example Middle Name: Anthony
period	Σ	0..1	Period	Time period when name was/is in use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Example Name use start date: 2021-01-01
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Example End date of name usage: 2021-12-31
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Example Contact type: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Example Contact Usage: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example Patient Gender: Male
birthDate	Σ	0..1	date	The date of birth for the individual Example Patient's date and time of birth: 2021-01-01
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not Example Patient death indicator: false
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Example Date and time of patient's death: 2021-12-31
address	Σ	0..*	Address	An address for the individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	CodeableConcept	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home Example Type of residence: home
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: RUA DA BURAQUEIRA N\XBA\11
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example City: ABRUNHEIRA
district	Σ	0..1	string	District name (aka county) Example General: Madison Example District/County: MONTEMOR O VELHO
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Example State: COIMBRA
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example Postal Code: 3140-015
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes Example Country: PT
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Patient Marital Status Code: M
display	Σ	0..1	string	Representation defined by the system Example Description of the patient's marital status: Married
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name Example Full Name: Mary Doe
family	Σ	0..1	string	Family name (often called 'Surname') Example Last Name: Doe
given	Σ	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 Example First Name: Mary
telecom		0..*	ContactPoint	A contact detail for the person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Example Contact Type: phone
value	Σ	0..1	string	The actual contact point details Example Telephone contact: 999999999
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Example Contact Usage: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
address		0..1	Address	Address for the contact person
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Parish		0..1	(Complex)	Extension URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"https://hl7.pt/fhir/patient-visit/StructureDefinition/Address"
value[x]		0..1	CodeableConcept	Value of extension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example Coding System: http://ine.pt
code	Σ	0..1	code	Symbol in syntax defined by the system Example Parish code: 061015
display	Σ	0..1	string	Representation defined by the system Example Description of the parish: União das Freguesias de Abrunheira, Verride e Vila Nova da Barca
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example Gender: Female
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system Example Code Primary Language: pt
display	Σ	0..1	string	Representation defined by the system Example Primary Language Display: Portuguese
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(PT_Practitioner | PT_PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.extension:Nationality.extension:code.value[x]	extensible	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.extension:Nationality.extension:code.value[x].coding	extensible	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from Patient

Summary

Prohibited: 58 elements

Structures

This structure refers to these other structures:

• PT_Organization (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTOrganization)
• PT_Practitioner (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitioner)
• PT_PractitionerRole (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitionerRole)

Extensions

This structure refers to these extensions:

• https://hl7.pt/fhir/patient-visit/StructureDefinition/Nationality
• https://hl7.pt/fhir/patient-visit/StructureDefinition/BirthPlace
• https://hl7.pt/fhir/patient-visit/StructureDefinition/Address

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.name.given
• The element 1 is sliced based on the value of Patient.deceased[x]
• The element 1 is sliced based on the value of Patient.multipleBirth[x]