Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core RelatedPerson

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson Version: 2.5.0
Active as of 2023-12-12 Computable Name: UKCoreRelatedPerson

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

This profile defines the UK constraints and extensions on the International FHIR resource RelatedPerson.

This profile allows exchange of information about a person that is involved in the care for an individual, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Usage:

Formal Views of Profile Content

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

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPerson
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... active S 0..1 boolean Whether this related person's record is in active use.
... patient S 1..1 Reference(Patient) The patient this person is related to.
... name S 0..* HumanName A name associated with the person.
... telecom S 0..* ContactPoint A contact detail for the person.
.... system
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... address S 0..* Address Address where the related person can be contacted or visited.
... communication
.... 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.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) The patient this person is related to.
... relationship SΣ 0..* CodeableConcept The nature of the relationship.
Binding: UK Core Person Relationship Type (extensible)
... name SΣ 0..* HumanName A name associated with the person.
... telecom SΣ 0..* ContactPoint A contact detail for the person.
.... 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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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Σ 1..1 Reference(Patient) The patient this person is related to.
... relationship SΣ 0..* CodeableConcept The nature of the relationship.
Binding: UK Core Person Relationship Type (extensible)
... name SΣ 0..* HumanName A name associated with the person.
... telecom SΣ 0..* ContactPoint A contact detail for the person.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value 0..1 string Primitive value for code
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address 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
.... 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.

.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPerson
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... active S 0..1 boolean Whether this related person's record is in active use.
... patient S 1..1 Reference(Patient) The patient this person is related to.
... name S 0..* HumanName A name associated with the person.
... telecom S 0..* ContactPoint A contact detail for the person.
.... system
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... address S 0..* Address Address where the related person can be contacted or visited.
... communication
.... 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.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) The patient this person is related to.
... relationship SΣ 0..* CodeableConcept The nature of the relationship.
Binding: UK Core Person Relationship Type (extensible)
... name SΣ 0..* HumanName A name associated with the person.
... telecom SΣ 0..* ContactPoint A contact detail for the person.
.... 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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... contactPreference 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
.... copyCorrespondenceIndicator 0..1 boolean Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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Σ 1..1 Reference(Patient) The patient this person is related to.
... relationship SΣ 0..* CodeableConcept The nature of the relationship.
Binding: UK Core Person Relationship Type (extensible)
... name SΣ 0..* HumanName A name associated with the person.
... telecom SΣ 0..* ContactPoint A contact detail for the person.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value 0..1 string Primitive value for code
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address 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
.... 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.

.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron