Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveRelatedPerson

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-RelatedPerson Version: 0.1.0
Active as of 2024-04-19 Computable Name: InterweaveRelatedPerson

Interweave Related Person resource profile

  Status: Active: Approved (STU)

Definition Information about a person that has a relationship with a patient. The person may be involved in the care or support of a patient, but is not the target of the care/support.

Introduction

NB: Whilst the term “Patient” is used by FHIR, the profile is equally relevant to a “citizen”, “service user” or “client” in other contexts such as Social Care.

This profile sets minimum expectations for the RelatedPerson resource to record Information about a person who has a relationship with a patient. The related person is always defined from the position of the patient e.g. This related person is the patient’s mother, spouse, brother etc. In Social Care, a related person may also play one or more roles in the service user’s support.

Coverage and references

  • A Data Provider MUST offer RelatedPerson FHIR resources to represent its own patients’ relationships (those that are relevant for regional sharing).

  • The related person resource does not negate the use of the patient.contact field. This should still be used to specify the person who should be contacted in an emergency, and the related person should be used to model all other relationships.

  • When referencing a RelatedPerson the “reference” (URL of FHIR Resource) and “display” (related person’s name) MUST be populated.

Mandatory fields

The following fields are mandatory:

  • name - “usual” name, what they liked to be known as, including given and family names. Its only relevant to capture the person’s current name, no history is required.

  • active - A mandatory flag to indicate whether the relatedPerson record is active.

  • patient - To whom this person has a relationship with.

  • relationship - How this person is related to the patient e.g. mother, spouse, brother etc.

Must Support fields

In addition, the following fields are “Must Support” - i.e. they must be populated if relevant and known:

  • telecom - how the related person can be contacted e.g. phone and/or email details. It’s only relevant to capture the person’s current contact details, no telecom history is appropriate.

  • socialCareSupportRole (Extension) - This extension has been developed for use by the Social Care sector, who have a requirement to model the role(s) which a related person plays in a service user’s support. We have specified a preferred interweave valueset for populating this field, which was developed with the Social Care Data Standards working group. Please note, that if ‘Other’ is entered here, then it is essential to provide additional detail of the role within the text field.

Background to extension: Initially we looked at whether we should adopt the R4 relationship field, which allows for multiple relationships to be specified, to support this requirement. however, as this breaks compliance with STU3 and given role is a different concept, it was agreed that this should be represented by a separate field.

  • period - The period during which the relationship existed.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:

  • address - Can be provided if known and relevant. Only the person’s current address should be captured.

  • gender and birthDate - These can be provided if known, but it is felt that these do not add much value to the related person record.

  • identifier:localIdentifier - An optional local identifier which may be helpful to identify the record at a local level.

Discouraged or Removed fields

  • photo - removed - not relevant here and adds size and complexity to the content

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-RelatedPerson-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... Slices for identifier 0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierA human identifier for this person
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value S1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... active S1..1booleanWhether this related person's record is in active use
... patient S1..1Reference(CareConnectPatient1)The patient this person is related to
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
.... display S1..1stringText alternative for the resource
... relationship S1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... name S1..*HumanNameA name associated with the person
.... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
.... text 0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family S1..1stringFamily name (often called 'Surname')
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix S0..*stringParts that come before the name
.... suffix S0..*stringParts that come after the name
... telecom S0..*ContactPointA contact detail for the person
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
... photo 0..0
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RelatedPerson.relationshiprequiredPatientRelationshipType
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... identifier:localIdentifier Σ0..1IdentifierA human identifier for this person
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value SΣ1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(CareConnectPatient1)The patient this person is related to
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... display SΣ1..1stringText alternative for the resource
... relationship SΣ1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
... name SΣ1..*HumanNameA name associated with the person
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... telecom SΣ0..*ContactPointA contact detail for the person
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point

... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommon Tags
RelatedPerson.meta.tag:SourceexampleCommon Tags
RelatedPerson.meta.tag:ProvenanceexampleCommon Tags
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier:localIdentifier.userequiredIdentifierUse
RelatedPerson.relationshiprequiredPatientRelationshipType
RelatedPerson.name.userequiredNameUse
RelatedPerson.telecom.systemrequiredContactPointSystem
RelatedPerson.telecom.userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierA human identifier for this person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value SΣ1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(CareConnectPatient1)The patient this person is related to
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display SΣ1..1stringText alternative for the resource
... relationship SΣ1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣ1..*HumanNameA name associated with the person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point

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

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommon Tags
RelatedPerson.meta.tag:SourceexampleCommon Tags
RelatedPerson.meta.tag:ProvenanceexampleCommon Tags
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier.typeextensibleIdentifier Type Codes
RelatedPerson.identifier:localIdentifier.userequiredIdentifierUse
RelatedPerson.identifier:localIdentifier.typeextensibleIdentifier Type Codes
RelatedPerson.relationshiprequiredPatientRelationshipType
RelatedPerson.name.userequiredNameUse
RelatedPerson.telecom.systemrequiredContactPointSystem
RelatedPerson.telecom.userequiredContactPointUse
RelatedPerson.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CareConnect-RelatedPerson-1

Summary

Mandatory: 7 elements (13 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element RelatedPerson.meta.tag is sliced based on the value of value:system
  • The element RelatedPerson.identifier is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-RelatedPerson-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... Slices for identifier 0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierA human identifier for this person
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value S1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... active S1..1booleanWhether this related person's record is in active use
... patient S1..1Reference(CareConnectPatient1)The patient this person is related to
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
.... display S1..1stringText alternative for the resource
... relationship S1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... name S1..*HumanNameA name associated with the person
.... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
.... text 0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family S1..1stringFamily name (often called 'Surname')
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix S0..*stringParts that come before the name
.... suffix S0..*stringParts that come after the name
... telecom S0..*ContactPointA contact detail for the person
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
... photo 0..0
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RelatedPerson.relationshiprequiredPatientRelationshipType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... identifier:localIdentifier Σ0..1IdentifierA human identifier for this person
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value SΣ1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(CareConnectPatient1)The patient this person is related to
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... display SΣ1..1stringText alternative for the resource
... relationship SΣ1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
... name SΣ1..*HumanNameA name associated with the person
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... telecom SΣ0..*ContactPointA contact detail for the person
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point

... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommon Tags
RelatedPerson.meta.tag:SourceexampleCommon Tags
RelatedPerson.meta.tag:ProvenanceexampleCommon Tags
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier:localIdentifier.userequiredIdentifierUse
RelatedPerson.relationshiprequiredPatientRelationshipType
RelatedPerson.name.userequiredNameUse
RelatedPerson.telecom.systemrequiredContactPointSystem
RelatedPerson.telecom.userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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..*CareConnect-RelatedPerson-1An person that is related to a patient, but who is not a direct target of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... socialCareSupportRole S0..*(Complex)Social Care Support Role: The role which a person plays in this service user's support
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierA human identifier for this person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-RelatedPerson-identifier
..... value SΣ1..1stringThe Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(CareConnectPatient1)The patient this person is related to
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display SΣ1..1stringText alternative for the resource
... relationship SΣ1..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣ1..*HumanNameA name associated with the person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point

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

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommon Tags
RelatedPerson.meta.tag:SourceexampleCommon Tags
RelatedPerson.meta.tag:ProvenanceexampleCommon Tags
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier.typeextensibleIdentifier Type Codes
RelatedPerson.identifier:localIdentifier.userequiredIdentifierUse
RelatedPerson.identifier:localIdentifier.typeextensibleIdentifier Type Codes
RelatedPerson.relationshiprequiredPatientRelationshipType
RelatedPerson.name.userequiredNameUse
RelatedPerson.telecom.systemrequiredContactPointSystem
RelatedPerson.telecom.userequiredContactPointUse
RelatedPerson.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CareConnect-RelatedPerson-1

Summary

Mandatory: 7 elements (13 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element RelatedPerson.meta.tag is sliced based on the value of value:system
  • The element RelatedPerson.identifier is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron