RelatedPerson-BNet-FatherPartner

FHIR Resource information

FHIR Resource	🌍RelatedPerson-BNet-FatherPartner. Based on 🌍 RelatedPerson
Description	Demographics for the father/partner of the child
Release status	NOT AVAIL. (RFC)
Cardinality	Single Instance
Writing to Spine permitted	YES - for Spine Client Type (NNU)
Spine filters	None

Key FHIR Resource elements used

id - Logical ID for the father/parner

Summary	Logical ID for the father/parner
Mandatory	No
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

patient - Reference to child patient.

Summary	Reference to child patient.
Mandatory	No
Value type	🌍Reference(Patient)
Write allowed	Yes
Data Dictionary item	None

* relationship - Relationship to child

Summary	Relationship to child
Mandatory	Yes
Expected type	🌍codeableConcept
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value: 'PRN', CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'', Display: 'parent'

* birthDate - Date of birth of spouse

Summary	Date of birth of spouse
Mandatory	Yes
Expected type	🌍date
Write allowed	Yes
Data Dictionary item	Partner.DOB - Partner/spouse's date of birth - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

name.prefix - Father/partner's title (prefix)

Summary	Father/partner's title (prefix)
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.NamePrefix - Partner/spouse's title - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

name.given - Father/partner's given name(s)

Summary	Father/partner's given name(s)
Description	Woman/pregnant person's given name(s) provided as an array.
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.Forename - Partner/spouse's forename - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

name.family - Father/partner's surname

Summary	Father/partner's surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.Surname - Partner/spouse's surname - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

name.use - Identifies the purpose for this name.

Summary	Identifies the purpose for this name.
Description	This item defines the type of name provided. This item should be either "official" or "usual".
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	Partner.NameUse - Partner/spouse's use of name - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

address.use - The purpose of this address.

Summary	The purpose of this address.
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value of 'home' should be used.

address.line - Father/partner address of residence

Summary	Father/partner address of residence
Description	3 address lines are permitted.
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.address.street - Partner/spouse's street address - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

address.city - Father/partner city/town of residence

Summary	Father/partner city/town of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.address.city - Partner/spouse's city of residence - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

address.postCode - Father/partner address Postcode (zip/postal code)

Summary	Father/partner address Postcode (zip/postal code)
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.address.postCode - Partner/spouse's postcode of residence - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

communication.language - Father/partner language

Summary	Father/partner language
Mandatory	No
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	Partner.Language - Partner/spouse's main language - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner
Value set used	🌍ValueSet-BNet-RelatedPerson-Languages

Telecom.Home - Father/partner's home telephone number

Summary	Father/partner's home telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.TelecomHome - Partner/spouse's home contact number - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

Telecom.Work - Father/partner's work telephone number

Summary	Father/partner's work telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.TelecomWork - Partner/spouse's work contact number - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

Telecom.Mobile - Father/partner's mobile telephone number

Summary	Father/partner's mobile telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.TelecomMobile - Partner/spouse's mobile contact number - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

Telecom.Email - Father/partner's email address

Summary	Father/partner's email address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Partner.TelecomEmail - Partner/spouse's email address - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner

extension:patientEthnicity - Father/partner's identity Ethnicity in the NZ region. The URL for this extension is http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity.

Summary	Father/partner's identity Ethnicity in the NZ region. The URL for this extension is http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity.
Mandatory	No
Expected type	🌍extension
Write allowed	Yes
Data Dictionary item	Partner.extension(Partner-ethnicity) - Partner/spouse's ethnic group - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner
Value set used	🌍ValueSet-BNet-Patient-EthnicityNZ

extension:patientEthnicity - Father/partner's identity Ethnicity in the UK region. The URL for this extension is https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory

Summary	Father/partner's identity Ethnicity in the UK region. The URL for this extension is https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
Mandatory	No
Expected type	🌍extension
Write allowed	Yes
Data Dictionary item	Partner.extension(Partner-ethnicity) - Partner/spouse's ethnic group - DataSet: (UKNEONATALSUMMARY) UK Neonatal Clinical Summary set - Topic: (NNU-FatherPartnerDemographics) Demographics of the father/partner
Value set used	🌍ValueSet-BNet-Patient-EthnicityUK

Example JSON when WRITING to the Spine

Example JSON pending, awaiting development.

Example JSON when READING from the Spine

Example JSON pending, awaiting development.

CONFIDENTIAL/COMMERCIAL IN CONFIDENCE

Confidentiality/document control

This document contains information that is confidential to System C Healthcare Ltd (System C) and is intended for our customers to use in connection with our products and services. It must not be used for any other purpose nor disclosed to any other party, either whole or in part, without the prior written consent of System C except as follows. A customer may permit those of its employees, advisors and agents having a need to know the contents of this platform to have access to such of the contents as are strictly necessary, but that customer shall ensure that such employees, advisors and agents are bound to it by an obligation, in similar term, to keep it confidential. A customer's acceptance of these obligations shall be indicated by that customer's use of any of the information contained in this document.

System C acknowledges that a customer may be bound by the Freedom of Information Act 2000 (FOIA). In such cases, System C considers that the contents of this document are confidential and exempt from disclosure pursuant to section 41 of the FOIA. A customer should consult System C before making any disclosure of information relating to System C under the FOIA. System C's business information, methodologies, solutions, as well as reference to System C clients and their projects, are always considered by System C to be exempt from disclosure by virtue of section 41 and 43 of the FOIA, whether indicated or not. 

Product Information: any descriptions of future functionality reflect current product direction, are for informational purposes only, and do not constitute a commitment to provide specific functionality. Timing and availability remain at System C’s discretion and are subject to change and applicable regulatory approvals.

Warning: Paper or PDF copies of this document are not version controlled and will automatically be considered obsolete and superseded at the time of printing or conversion.

Confidentiality/document control statement version number 2.0, QMSUID-0059