Example Usage Scenarios:

The following are example usage scenarios for this profile:

• Query for a related person that supports the patient.
• Query for a person related to the patient by name.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each RelatedPerson Must Have:

1. a status
2. a patient

Each RelatedPerson Must Support:

1. the relationship to the patient
2. the name of the related person
3. the telecom of the related person
4. the address of the related person

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

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
active	S	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SC	0..*	CodeableConcept	(USCDI) The nature of the relationship
name	SC	0..*	HumanName	(USCDI) A name associated with the person
telecom	S	0..*	ContactPoint	(USCDI) A contact detail for the person
address	S	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType

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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
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
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
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	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
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
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
active	S	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SC	0..*	CodeableConcept	(USCDI) The nature of the relationship
name	SC	0..*	HumanName	(USCDI) A name associated with the person
telecom	S	0..*	ContactPoint	(USCDI) A contact detail for the person
address	S	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType

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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
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
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
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	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
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
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

• The syntax used to describe the interactions is described here.

• Servers providing access to related person data can use US Core SMART Scopes for:
  • resource level scopes (for example, patient/RelatedPerson.rs).
• See the General Requirements section for additional rules and expectations when a server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support both read RelatedPerson by id AND RelatedPerson search using the _id search parameter:

   GET [base]/RelatedPerson/[id] or GET [base]/RelatedPerson?_id=[id]

   Example:

   1. GET [base]/RelatedPerson/shaw-niece
   2. GET [base]/RelatedPerson?_id=shaw-niece

   Implementation Notes: (how to search by the logical id of the resource)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

1. SHOULD support searching for all relatedpersons for a patient using the patient search parameter:

   GET [base]/RelatedPerson?patient={Type/}[id]

   Example:

   1. GET [base]/RelatedPerson?patient=1032702

   Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient (how to search by reference)

2. SHOULD support searching using the combination of the patient and name search parameters:

   GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]

   Example:

   1. GET [base]/RelatedPerson?patient=1137192&name=van%20Putten

   Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient that may match any of the string fields in the name element (including family, give, prefix, suffix, suffix, and/or text) (how to search by reference and how to search by string)