CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR), published by APHL. 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/lantanagroup/FHIR-us-eicr-anonymized/ and changes regularly. See the Directory of published versions

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

Resource Profile: eICR Anonymized RelatedPerson

This RelatedPerson profile represents an anonymized eCR RelatedPerson.

Usage:

• Refer to this Resource Profile: eICR Anonymized Past or Present Job
• Examples for this Resource Profile: RelatedPerson/relatedperson-anon

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
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
div		1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
identifier	C	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
patient		1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
name	C	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
telecom	C	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
birthDate	C	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
address	C	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')

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
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	ΣC	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
name	ΣC	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom	ΣC	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	ΣC	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
address	ΣC	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.text.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.text.status	required	NarrativeStatus http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
RelatedPerson.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 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()
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')
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()
txt-1	error	RelatedPerson.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	RelatedPerson.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

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	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	ΣC	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
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
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	ΣC	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
telecom	ΣC	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	ΣC	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	date	Primitive value for date
address	ΣC	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
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
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.text.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.text.status	required	NarrativeStatus http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
RelatedPerson.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.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()
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')
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()
txt-1	error	RelatedPerson.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	RelatedPerson.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element(12 nested mandatory elements)
Must-Support: 6 elements
Fixed: 6 elements

Structures

This structure refers to these other structures:

• eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			RelatedPerson
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
div		1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
identifier	C	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
patient		1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
name	C	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
telecom	C	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
birthDate	C	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
address	C	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')

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
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	ΣC	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
name	ΣC	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom	ΣC	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	ΣC	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
address	ΣC	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.text.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.text.status	required	NarrativeStatus http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
RelatedPerson.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 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()
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')
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()
txt-1	error	RelatedPerson.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	RelatedPerson.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

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	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	ΣC	0..*	Identifier	A human identifier for this person eicr-anon-rp-iden: RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.identifier is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
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
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(eICR Anonymized Patient)	The patient of this anonymized Past or Present Job is the anonymized Patient
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	ΣC	0..*	HumanName	A name associated with the person eicr-anon-rp-name: RelatedPerson.name fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
telecom	ΣC	0..*	ContactPoint	A contact detail for the person eicr-anon-rp-tel: RelatedPerson.telecom fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.telecom is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	ΣC	0..1	date	The date on which the related person was born eicr-anon-rp-bd: Patient.birthDate.value SHALL NOT be present
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	RelatedPerson.birthDate is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	date	Primitive value for date
address	ΣC	0..*	Address	Address where the related person can be contacted or visited eicr-anon-rp-ad: RelatedPerson.address fields SHALL NOT be present
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	ReleatedPerson.address is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
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
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.text.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.text.status	required	NarrativeStatus http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
RelatedPerson.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
RelatedPerson.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.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()
eicr-anon-rp-ad	error	RelatedPerson.address	RelatedPerson.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-rp-bd	error	RelatedPerson.birthDate	Patient.birthDate.value SHALL NOT be present : value.empty()
eicr-anon-rp-iden	error	RelatedPerson.identifier	RelatedPerson.identifier.system SHALL NOT be present AND Patient.identifier.value SHALL NOT be present : system.empty() and value.empty()
eicr-anon-rp-name	error	RelatedPerson.name	RelatedPerson.name fields SHALL NOT be present : use.empty() and text.empty() and given.empty() and prefix.empty() and suffix.empty() and period.empty()
eicr-anon-rp-tel	error	RelatedPerson.telecom	RelatedPerson.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	RelatedPerson.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>')
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()
txt-1	error	RelatedPerson.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	RelatedPerson.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element(12 nested mandatory elements)
Must-Support: 6 elements
Fixed: 6 elements

Structures

This structure refers to these other structures:

• eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Other representations of profile: CSV, Excel, Schematron