HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

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

Resource Profile: PT_RelatedPerson

A generic RelatedPerson resource for Portugal

Usage:

• Refer to this Resource Profile: Operation, PT_Condition, PT_Coverage, PT_Encounter... Show 4 more, PT_MedicationAdministration, PT_NutritionOrder, PT_Procedure and Reporter

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 RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			RelatedPerson
identifier
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
display		0..1	string	Text alternative for the resource
patient
display		0..1	string	Text alternative for the resource
relationship		0..*	CodeableConcept	The nature of the relationship
coding
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..*	HumanName	A name associated with the person
text		0..1	string	Text representation of the full name
family		0..1	string	Family name (often called 'Surname')
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
telecom		0..*	ContactPoint	A contact detail for the person
system		0..1	code	phone | fax | email | pager | url | sms | other
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point
gender		0..1	code	male | female | other | unknown
birthDate		0..1	date	The date on which the related person was born
address		0..*	Address	Address where the related person can be contacted or visited
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
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
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
coding
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
Documentation for this format

Terminology Bindings (Differential)

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

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
display	Σ	0..1	string	Text alternative for the resource
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
text	Σ	0..1	string	Plain text representation of the concept
name	Σ	0..*	HumanName	A name associated with the person
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
family	Σ	0..1	string	Family name (often called 'Surname')
telecom	Σ	0..*	ContactPoint	A contact detail for the person
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
RelatedPerson.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
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
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	Σ	0..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
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
family	Σ	0..1	string	Family name (often called 'Surname')
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
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
id		0..1	string	Unique id for inter-element referencing
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
telecom	Σ	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
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.
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.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
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
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
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"}
id		0..1	string	Unique id for inter-element referencing
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
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
id		0..1	string	Unique id for inter-element referencing
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
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's 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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
RelatedPerson.identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
RelatedPerson.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
RelatedPerson.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
RelatedPerson.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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 RelatedPerson

Summary

Extensions

This structure refers to these extensions:

• http://hl7.pt/fhir/core/StructureDefinition/PTAddress

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			RelatedPerson
identifier
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
display		0..1	string	Text alternative for the resource
patient
display		0..1	string	Text alternative for the resource
relationship		0..*	CodeableConcept	The nature of the relationship
coding
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..*	HumanName	A name associated with the person
text		0..1	string	Text representation of the full name
family		0..1	string	Family name (often called 'Surname')
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
telecom		0..*	ContactPoint	A contact detail for the person
system		0..1	code	phone | fax | email | pager | url | sms | other
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point
gender		0..1	code	male | female | other | unknown
birthDate		0..1	date	The date on which the related person was born
address		0..*	Address	Address where the related person can be contacted or visited
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
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
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
period
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
coding
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
Documentation for this format

Terminology Bindings (Differential)

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
display	Σ	0..1	string	Text alternative for the resource
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
text	Σ	0..1	string	Plain text representation of the concept
name	Σ	0..*	HumanName	A name associated with the person
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
family	Σ	0..1	string	Family name (often called 'Surname')
telecom	Σ	0..*	ContactPoint	A contact detail for the person
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
RelatedPerson.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
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
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	Σ	0..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
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
family	Σ	0..1	string	Family name (often called 'Surname')
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
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
id		0..1	string	Unique id for inter-element referencing
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
telecom	Σ	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
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.
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.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
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
Parish		0..1	CodeableConcept	Extension URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
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"}
id		0..1	string	Unique id for inter-element referencing
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
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
id		0..1	string	Unique id for inter-element referencing
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
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's 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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
RelatedPerson.identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
RelatedPerson.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
RelatedPerson.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
RelatedPerson.address.country	preferred	Iso3166-1-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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 RelatedPerson

Summary

Extensions

This structure refers to these extensions:

• http://hl7.pt/fhir/core/StructureDefinition/PTAddress

Other representations of profile: CSV, Excel, Schematron