CareConnect-CDS-RelatedPerson-1

This is the StructureDefinition overview for the CareConnect-CDS-RelatedPerson-1

The official URL for this profile is: https://fhir.nottinghamshire.gov.uk/STU3/StructureDefinition/CareConnect-CDS-RelatedPerson-1

Differential

idS Σ1..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriFixed Value
valueΣ1..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
activeΣ ?!0..1boolean
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyΣ0..1string
givenΣ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
textΣ1..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
genderΣ0..1codeBinding
birthDateS Σ0..1date
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
contentTypeΣ0..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlΣ0..1uri
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationΣ0..1dateTime
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime

Hybrid

idS Σ1..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriFixed Value
valueΣ1..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
activeΣ ?!0..1boolean
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyΣ0..1string
givenΣ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
textΣ1..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
genderΣ0..1codeBinding
birthDateS Σ0..1date
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
contentTypeΣ0..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlΣ0..1uri
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationΣ0..1dateTime
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime

Snapshot (default)

idS Σ1..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriFixed Value
valueΣ1..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
activeΣ ?!0..1boolean
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyΣ0..1string
givenΣ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
useΣ ?!1..1codeBindingFixed Value
textΣ1..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
genderΣ0..1codeBinding
birthDateS Σ0..1date
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
contentTypeΣ0..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlΣ0..1uri
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationΣ0..1dateTime
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime



RelatedPerson Data Mapping

The table below provides the business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-CDS-RelatedPerson-1 profile. The CareConnect-CDS-RelatedPerson-1 profile is used to share detail of individuals that the Local Authority have recorded as having a relationship to the patient.

FHIR Element Card. Type Description/Business Context
RelatedPerson.id 1..1 id Logical id of related person from Social Care System and used for referencing resource within the Bundle
RelatedPerson.identifier 0..* identifier Constraint: Multiple identifiers may be provided, however providers MUST SUPPORT one being the NHS Number so that clients can link to local record of related person
RelatedPerson.identifier[nhsNumber] 0..1 identifier Constraint: For the NHS Number:

Patient.identifier.use = 'official'

Patient.identifier.system = 'https://fhir.nhs.uk/Id/nhs-number'

Patient.identifier.value={nhsNumber}
RelatedPerson.patient 1..1 Reference (CareConnect-CDS-Patient-1) Reference to the patient this person is related to
RelatedPerson.name 1..* HumanName Constraint: Multiple names may be provided, however one SHALL be the official name, i.e.

RelatedPerson.name.use = 'official'
RelatedPerson.relationship.coding 1..* coding Constraint: Multiple relationship.codings are allowed, however one MUST be the relationshipType and implementers MUST SUPPORT th epossibility of multiple relationshipFlags (see below)
RelatedPerson.relationship.coding[relationshipType] 1..1 coding The relationshipType is used to identify primary type of relationship (e.g. Parent, Sibling, Spouse, Child, Friend, Neighbour etc.)
RelatedPerson.relationship.coding[relationshipType].system 1..1 uri Fixed Value http://CareDataService/RelatedPerson/relationship-type

Note the fixed coding.system can be used by consumers to retrieve the appropriate relationship type text to display for a user interface using FHIRPath
RelatedPerson.relationship.coding[relationshipType].display 1..1 string Plain text representation of relationship type for display in a user interface.

Note coding.code is not required/supported as http://CareDataService/RelatedPerson/relationship-type is not a defined CodeSystem
RelatedPerson.relationship.coding[relationshipFlag] 0..* coding The relationshipFlag is used to identify any additional roles the related person or patient perform on behalf of the other (e.g. Carer, Next of Kin, Emergency Contact, Dependent, etc.)
RelatedPerson.relationship.coding[relationshipFlag].system 1..1 uri Each relationshipFlag MUST have a system wth

Fixed Value http://CareDataService/RelatedPerson/relationship-flag

Note the fixed coding.system can be used by consumers to retrieve the appropriate relationship flag(s) to display for a user interface using FHIRPath
RelatedPerson.relationship.coding[relationshipFlag].display 1..1 string Each relationshipFlag MUST have a plain text representation of relationship flag for display in a user interface.

Note coding.code is not required/supported as http://CareDataService/RelatedPerson/relationship-flag is not a defined CodeSystem
RelatedPerson.name[official].text 1..1 string Constraint: Where RelatedPerson.name.use='official', RelatedPerson.name.text SHALL be provided
RelatedPerson.name[official].family 1..1 string Constraint: Where RelatedPerson.name.use='official', RelatedPerson.name.family SHALL be provided
RelatedPerson.name[official].given 0..* string Constraint: Where recorded in the source system, and if RelatedPerson.name.use='official', RelatedPerson.name.given MUST BE SUPPORTED
RelatedPerson.telecom 0..* ContactPoint Optional data element for the contact points for a given contact (e.g. phone, fax, email, etc.)
RelatedPerson.birthdate 0..1 date The date on which the related person was born. This could be key, for example an Emergency Department needed to see that a Patient being admitted was the main carer of a minor.