Atrius India Core FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Atrius India Core RelatedPerson

Atrius India Core profile. Parent: FHIR R4. Structurally aligned with QI-Core. India terminology via NDHM ValueSets where noted. Legacy QI-Core projection: runtime-mapper.

Usages:

• Refer to this Profile: Atrius India Core AdverseEvent, Atrius India Core Appointment, Atrius India Core CareTeam, Atrius India Core Claim... Show 24 more, Atrius India Core Communication, Atrius India Core CommunicationRequest, Atrius India Core Coverage, Atrius India Core DeviceRequest, Atrius India Core DeviceUseStatement, Atrius India Core Diagnostic Report Record, Atrius India Core Discharge Summary Record, Atrius India Core Encounter, Atrius India Core Health Document Record, Atrius India Core ImagingStudy, Atrius India Core Immunization Record, Atrius India Core Invoice Record, Atrius India Core MedicationAdministration, Atrius India Core MedicationDispense, Atrius India Core MedicationRequest, Atrius India Core MedicationStatement, Atrius India Core Observation, Atrius India Core OP Consult Record, Atrius India Core Patient, Atrius India Core Procedure, Atrius India Core QuestionnaireResponse, Atrius India Core ServiceRequest, Atrius India Core Task and Atrius India Core Wellness Record
• Examples for this Profile: RelatedPerson/atrius-in-relatedperson-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	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 Constraints: ext-1
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient relationship type	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.name, RelatedPerson.telecom, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	RelatedPerson.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	A person that is related to a patient, but who is not a direct target of care
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	S	0..*	CodeableConcept	The nature of the relationship
name	S	0..*	HumanName	A name associated with the person
telecom	S	0..*	ContactPoint	A contact detail for the person
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the related person was born
address	S	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient relationship type	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	RelatedPerson.meta, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.name, RelatedPerson.telecom, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.photo, RelatedPerson.period, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 1 element
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• Atrius India Core Patient (https://atrius.in/fhir/r4/atrius-in/StructureDefinition/atrius-in-patient|0.1.0)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	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 Constraints: ext-1
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient relationship type	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.name, RelatedPerson.telecom, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	RelatedPerson.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	A person that is related to a patient, but who is not a direct target of care
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	S	0..*	CodeableConcept	The nature of the relationship
name	S	0..*	HumanName	A name associated with the person
telecom	S	0..*	ContactPoint	A contact detail for the person
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the related person was born
address	S	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson(4.0.1)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Atrius India Core Patient(0.1.0))	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient relationship type	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	RelatedPerson.meta, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.name, RelatedPerson.telecom, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.photo, RelatedPerson.period, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 1 element
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• Atrius India Core Patient (https://atrius.in/fhir/r4/atrius-in/StructureDefinition/atrius-in-patient|0.1.0)

Other representations of profile: CSV, Excel, Schematron