Social Care Interoperability Platform FHIR Implementation Guide
Version: 0.1.0, Status: draft

Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MODS Related Person

Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-RelatedPerson Version: 0.1.0
Draft as of 2026-03-24 Computable Name: MODSRelatedPerson

This profile defines the MODS constraints and extensions on the UKCore FHIR Resource RelatedPerson

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson 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
... Slices for extension Content/Rules for all slices
.... extension:contactPreference N 0..1 (Complex) The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
.... extension:copyCorrespondenceIndicator N 0..1 boolean Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... patient SΣC 1..1 Reference(Patient) The patient this person is related to
Constraints: ref-1
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person.
... name SΣ 0..* HumanName A name associated with the person
... Slices for telecom SΣC 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
Constraints: cpt-2
.... telecom:All Slices Content/Rules for all slices
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 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.
.... telecom:email SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 1..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.
.... telecom:phone SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 1..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.
... address SΣ 0..* Address Address where the related person can be contacted or visited
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu2 v2.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom, RelatedPerson.telecom:email, RelatedPerson.telecom:phone A system is required if a value is provided. value.empty() or system.exists()
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()
ref-1 error RelatedPerson.patient SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from UKCoreRelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson A person that is related to a patient, but who is not a direct target of care
... Slices for extension Content/Rules for all slices
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
.... telecom:email 0..* ContactPoint A contact detail for the person
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
.... telecom:phone 0..* ContactPoint A contact detail for the person
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
... address
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson 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
... 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
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:contactPreference N 0..1 (Complex) The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
.... extension:copyCorrespondenceIndicator N 0..1 boolean Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣC 1..1 Reference(Patient) The patient this person is related to
Constraints: ref-1
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person.
... name SΣ 0..* HumanName A name associated with the person
... Slices for telecom SΣC 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
Constraints: cpt-2
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
.... telecom:email SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 1..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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
.... telecom:phone SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 1..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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
... 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 Address where the related person can be contacted or visited
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)
.... 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 SΣ 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 SΣ 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 SΣ 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo C 0..* Attachment Image of the person
Constraints: att-1
... period C 0..1 Period Period of time that this relationship is considered valid
Constraints: per-1
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco 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 extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu2 v2.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base required All Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error RelatedPerson.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error RelatedPerson.telecom, RelatedPerson.telecom:email, RelatedPerson.telecom:phone A system is required if a value is provided. value.empty() or system.exists()
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()
per-1 error RelatedPerson.telecom.period, RelatedPerson.telecom:email.period, RelatedPerson.telecom:phone.period, RelatedPerson.address.period, RelatedPerson.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error RelatedPerson.patient SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson 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
... Slices for extension Content/Rules for all slices
.... extension:contactPreference N 0..1 (Complex) The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
.... extension:copyCorrespondenceIndicator N 0..1 boolean Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... patient SΣC 1..1 Reference(Patient) The patient this person is related to
Constraints: ref-1
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person.
... name SΣ 0..* HumanName A name associated with the person
... Slices for telecom SΣC 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
Constraints: cpt-2
.... telecom:All Slices Content/Rules for all slices
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 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.
.... telecom:email SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 1..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.
.... telecom:phone SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
...... Slices for extension Content/Rules for all slices
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value SΣ 1..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.
... address SΣ 0..* Address Address where the related person can be contacted or visited
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu2 v2.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom, RelatedPerson.telecom:email, RelatedPerson.telecom:phone A system is required if a value is provided. value.empty() or system.exists()
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()
ref-1 error RelatedPerson.patient SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from UKCoreRelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson A person that is related to a patient, but who is not a direct target of care
... Slices for extension Content/Rules for all slices
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
.... telecom:email 0..* ContactPoint A contact detail for the person
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
.... telecom:phone 0..* ContactPoint A contact detail for the person
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
... address
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* UKCoreRelatedPerson 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
... 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
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:contactPreference N 0..1 (Complex) The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
.... extension:copyCorrespondenceIndicator N 0..1 boolean Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣC 1..1 Reference(Patient) The patient this person is related to
Constraints: ref-1
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person.
... name SΣ 0..* HumanName A name associated with the person
... Slices for telecom SΣC 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
Constraints: cpt-2
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
.... telecom:email SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
Binding: MODS Email Address Type (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 1..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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
.... telecom:phone SΣC 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
Binding: MODS Person Telephone Number Type Code (required)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:otherContactSystem N 0..1 CodeableConcept Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 code Primitive value for code
Max Length:1048576
..... value SΣ 1..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 ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
... 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 Address where the related person can be contacted or visited
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addressCountry S 1..1 Coding Extension MODS Address Country
URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
Binding: MODS Country (required)
.... 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 SΣ 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 SΣ 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 SΣ 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo C 0..* Attachment Image of the person
Constraints: att-1
... period C 0..1 Period Period of time that this relationship is considered valid
Constraints: per-1
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco 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 extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu2 v2.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base required All Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error RelatedPerson.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error RelatedPerson.telecom, RelatedPerson.telecom:email, RelatedPerson.telecom:phone A system is required if a value is provided. value.empty() or system.exists()
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()
per-1 error RelatedPerson.telecom.period, RelatedPerson.telecom:email.period, RelatedPerson.telecom:phone.period, RelatedPerson.address.period, RelatedPerson.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error RelatedPerson.patient SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

 

Other representations of profile: CSV, Excel, Schematron