NHS North West Genomics
0.2.1 - ci-build United Kingdom flag

NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions

Resource Profile: RelatedPerson

Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/RelatedPerson Version: 0.2.1
Draft as of 2026-02-27 Computable Name: RelatedPerson
Keywords: Core, Patient Administration

Patient Administration

Reference:

RelatedPerson will often be used to represent a mother when testing a fetus (Patient). For example:

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 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
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:MedicalRecordNumber SΣ 0..* MedicalRecordNumber Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Fixed Value: As shown (Medical record number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system SΣ 0..1 uri Generic system to represent MRN in NHS Trusts. Can be replaced with a system specified by NHS Trust. For trusts with a PAS/EPR with a FHIR API (e.g. EPIC, Meditech, Cerner, etc), this value will be defined in that API.
Example General: http://www.acme.com/identifiers/patient
Example EPIC EPI OID: 1.2.840.114350.1.13.0.1.7.5.737384.0
..... value SΣ 1..1 string The value MUST be unique to the organisation
Example General: 123456
..... assigner SΣ 1..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
.... identifier:nhsNumber SΣ 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (National Health Plan Identifier)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Binding: UK National Health Identifiers (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
... 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.
.... identifier Σ 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
... 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.
... 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.
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​type Base required NW IdentifierType 📦0.2.1 This IG
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​system Base required UK National Health Identifiers 📦0.2.1 This IG
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu3.currentbuild v0.0
RelatedPerson.telecom.​use Base required ContactPointUse 📍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 **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 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 identifier S 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... assigner S 0..1 Reference(Organization) Assigning Facility
...... identifier S 1..1 Identifier Logical reference, when literal reference is not known
....... system 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value S 1..1 string The value that is unique
.... identifier:MedicalRecordNumber S 0..* MedicalRecordNumber Medical Record Number
.... identifier:nhsNumber S 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
... patient
.... identifier 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
... birthDate S 0..1 date The date on which the related person was born

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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
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
... Slices for extension 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 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
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
.... identifier:MedicalRecordNumber SΣ 0..* MedicalRecordNumber Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Fixed Value: As shown (Medical record number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system SΣ 0..1 uri Generic system to represent MRN in NHS Trusts. Can be replaced with a system specified by NHS Trust. For trusts with a PAS/EPR with a FHIR API (e.g. EPIC, Meditech, Cerner, etc), this value will be defined in that API.
Example General: http://www.acme.com/identifiers/patient
Example EPIC EPI OID: 1.2.840.114350.1.13.0.1.7.5.737384.0
..... value SΣ 1..1 string The value MUST be unique to the organisation
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
.... identifier:nhsNumber SΣ 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (National Health Plan Identifier)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Binding: UK National Health Identifiers (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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.
... 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:otherContactSystem N 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 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
.... 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​type Base required NW IdentifierType 📦0.2.1 This IG
RelatedPerson.identifier:MedicalRecordNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​system Base required UK National Health Identifiers 📦0.2.1 This IG
RelatedPerson.identifier:nhsNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu3.currentbuild v0.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base required All 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 **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 UKCoreRelatedPerson

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier

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 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
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:MedicalRecordNumber SΣ 0..* MedicalRecordNumber Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Fixed Value: As shown (Medical record number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system SΣ 0..1 uri Generic system to represent MRN in NHS Trusts. Can be replaced with a system specified by NHS Trust. For trusts with a PAS/EPR with a FHIR API (e.g. EPIC, Meditech, Cerner, etc), this value will be defined in that API.
Example General: http://www.acme.com/identifiers/patient
Example EPIC EPI OID: 1.2.840.114350.1.13.0.1.7.5.737384.0
..... value SΣ 1..1 string The value MUST be unique to the organisation
Example General: 123456
..... assigner SΣ 1..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
.... identifier:nhsNumber SΣ 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (National Health Plan Identifier)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Binding: UK National Health Identifiers (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
... 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.
.... identifier Σ 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
... 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.
... 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.
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​type Base required NW IdentifierType 📦0.2.1 This IG
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​system Base required UK National Health Identifiers 📦0.2.1 This IG
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu3.currentbuild v0.0
RelatedPerson.telecom.​use Base required ContactPointUse 📍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 **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 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 identifier S 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... assigner S 0..1 Reference(Organization) Assigning Facility
...... identifier S 1..1 Identifier Logical reference, when literal reference is not known
....... system 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value S 1..1 string The value that is unique
.... identifier:MedicalRecordNumber S 0..* MedicalRecordNumber Medical Record Number
.... identifier:nhsNumber S 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
... patient
.... identifier 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
... birthDate S 0..1 date The date on which the related person was born

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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
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
... Slices for extension 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 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
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
.... identifier:MedicalRecordNumber SΣ 0..* MedicalRecordNumber Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Fixed Value: As shown (Medical record number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system SΣ 0..1 uri Generic system to represent MRN in NHS Trusts. Can be replaced with a system specified by NHS Trust. For trusts with a PAS/EPR with a FHIR API (e.g. EPIC, Meditech, Cerner, etc), this value will be defined in that API.
Example General: http://www.acme.com/identifiers/patient
Example EPIC EPI OID: 1.2.840.114350.1.13.0.1.7.5.737384.0
..... value SΣ 1..1 string The value MUST be unique to the organisation
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
.... identifier:nhsNumber SΣ 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (National Health Plan Identifier)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Binding: UK National Health Identifiers (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Assigning Facility
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 MedicalRecordNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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.
... 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:otherContactSystem N 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 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
.... 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​type Base required NW IdentifierType 📦0.2.1 This IG
RelatedPerson.identifier:MedicalRecordNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:MedicalRecordNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​system Base required UK National Health Identifiers 📦0.2.1 This IG
RelatedPerson.identifier:nhsNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:nhsNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible UK Core Person Relationship Type 📦2.1.0 fhir.r4.ukcore.stu3.currentbuild v0.0
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base required All 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 **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 UKCoreRelatedPerson

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier

 

Other representations of profile: CSV, Excel, Schematron