The FHIR profiles used for the Family history Bundle

Heading Description

Information on illness in family relations relevant to the health or care of the woman.

The following profiles are referenced from the investigation results details list structure:

Family History Structure Details

Page-1 Dynamic connector.2754 Dynamic connector.2755 Family History of Fetus List Resource Family History of Fetus List Resource Family History of FetusList Resource Family History of Woman List Resource Family History of Woman List Resource Family History of WomanList Resource Dynamic connector.2758 Dynamic connector.2759 FamilyMember History Resource FamilyMember History Resource FamilyMemberHistoryResource Dynamic connector.2761 Location Resource Location Resource LocationResource 1..1 M subject 1..1 M subject 1..1 Msubject 0..1 R entry.item 0..1 R entry.item 0..1 Rentry.item 0..1 R entry.item 0..1 R entry.item 0..1 Rentry.item 0..* R entry.item 0..* R entry.item 0..* Rentry.item 0..* R entry.item 0..* R entry.item 0..* Rentry.item Encounter Resource Encounter Resource EncounterResource Dynamic connector.2769 1..1 M encounter 1..1 M encounter 1..1 Mencounter 1..1 M location 1..1 M location 1..1 Mlocation Dynamic connector.2772 Location Resource Location Resource LocationResource Encounter Resource Encounter Resource EncounterResource Dynamic connector.2775 1..1 M encounter 1..1 M encounter 1..1 Mencounter 1..1 M location 1..1 M location 1..1 Mlocation Family History List Resource Family History List Resource Family HistoryList Resource 1..1 M subject 1..1 M subject 1..1 Msubject Reference to Patient resource Reference to Patient resource Reference to Patient resource Dynamic connector.1721

Mapping Overview

Date/Time FamilyMemberHistory date
ODS/ORD Site Code Location identifier
Family History FamilyMemberHistory condition.code
Person in the Family   relationship
Comment   note

Mapping for Family History List

> Level 1 List Resource > Level 2 CareConnect-List-1 Profile > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Digital Maternity Implementation
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-List-1'
- identifier 0..* Required Identifier Business identifier
An identifier for this Family History details list
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - value 1..1 Mandatory String The value that is unique
An identifier for this Family History details list
- status 1..1 Mandatory Code current : retired : entered-in-error
Binding (required): The current state of the list ListStatus
The status of the list MUST contain the value 'current'
- mode 1..1 Mandatory Code working : snapshot : changes
Binding (required): The processing mode that applies to this list ListMode
The mode of the list MUST contain the value 'snapshot'
- title 0..1 Mandatory String Descriptive name for the list
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading GP Practice'
- code 0..1 Mandatory CodeableConcept What the purpose of this list is
Binding (preferred): What the purpose of a list is CareConnect-ListCode-1
The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set
- - coding 0..* Mandatory Coding Code defined by a terminology system
The SNOMED CT concept for the PRSB heading type
- - - system 0..1 Mandatory Uri Identity of the terminology system
This MUST contain the value 'http://snomed.info/sct'
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain the value '163051000000102'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading Family History'
- subject 0..1 Mandatory Reference If all resources have the same subject
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
This is a reference to the Patient who is the subject of the list.
    Mandatory CareConnect-Patient-1 This is the subject of the Family History details List. This MUST use the CareConnect patient profile.See patient resource reference for information on how to populate the resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle
- date 0..1 Required dateTime When the list was prepared
This MUST contain a system date to indicate when the list was created or updated
- entry 0..* Required BackboneElement Entries in the list
The entries MUST be as per the diagram for this PRSB headings list. MAY contain a 'Family History of Fetus List' and/or 'Family History of Woman List'
- - date 0..1 Required dateTime When item added to list
The SHOULD contain a system time of when the item was added to the list.
- - item 1..1 Mandatory Reference Actual entry
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
A references to Organization, Practice and Flag resources MAY be included in the list. These MUST use the CareConnect profiles.
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL The reference to the included CareConnect resource.

Mapping for Family History of Fetus List

> Level 1 List Resource > Level 2 CareConnect-List-1 Profile > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Digital Maternity Implementation
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-List-1'
- identifier 0..* Required Identifier Business identifier
An identifier for this Family History details list
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - value 1..1 Mandatory String The value that is unique
An identifier for this Family History details list
- status 1..1 Mandatory Code current : retired : entered-in-error
Binding (required): The current state of the list ListStatus
The status of the list MUST contain the value 'current'
- mode 1..1 Mandatory Code working : snapshot : changes
Binding (required): The processing mode that applies to this list ListMode
The mode of the list MUST contain the value 'snapshot'
- title 0..1 Mandatory String Descriptive name for the list
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading GP Practice'
- code 0..1 Mandatory CodeableConcept What the purpose of this list is
Binding (preferred): What the purpose of a list is CareConnect-ListCode-1
The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set
- - coding 0..* Mandatory Coding Code defined by a terminology system
The SNOMED CT concept for the PRSB heading type
- - - system 0..1 Mandatory Uri Identity of the terminology system
This MUST contain the value 'http://snomed.info/sct'
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain the value '163051000000102'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading Family History'
- subject 0..1 Mandatory Reference If all resources have the same subject
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
This is a reference to the Patient who is the subject of the list.
    Mandatory CareConnect-Patient-1 This is the subject of the Family History details List. This MUST use the CareConnect patient profile.See patient resource reference for information on how to populate the resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle
- date 0..1 Required dateTime When the list was prepared
This MUST contain a system date to indicate when the list was created or updated
- entry 0..* Required BackboneElement Entries in the list
The entries MUST be as per the diagram for this PRSB headings list. MUST contain a 'Encounter Resource' and/ MAY inlcude a 'FamilyMemberHistory resource'
- - date 0..1 Required dateTime When item added to list
The SHOULD contain a system time of when the item was added to the list.
- - item 1..1 Mandatory Reference Actual entry
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
A references to Organization, Practice and Flag resources MAY be included in the list. These MUST use the CareConnect profiles.
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL The reference to the included CareConnect resource.

Mapping for Family History of Woman List

> Level 1 List Resource > Level 2 CareConnect-List-1 Profile > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Digital Maternity Implementation
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-List-1'
- identifier 0..* Required Identifier Business identifier
An identifier for this Family History details list
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - value 1..1 Mandatory String The value that is unique
An identifier for this Family History details list
- status 1..1 Mandatory Code current : retired : entered-in-error
Binding (required): The current state of the list ListStatus
The status of the list MUST contain the value 'current'
- mode 1..1 Mandatory Code working : snapshot : changes
Binding (required): The processing mode that applies to this list ListMode
The mode of the list MUST contain the value 'snapshot'
- title 0..1 Mandatory String Descriptive name for the list
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading GP Practice'
- code 0..1 Mandatory CodeableConcept What the purpose of this list is
Binding (preferred): What the purpose of a list is CareConnect-ListCode-1
The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set
- - coding 0..* Mandatory Coding Code defined by a terminology system
The SNOMED CT concept for the PRSB heading type
- - - system 0..1 Mandatory Uri Identity of the terminology system
This MUST contain the value 'http://snomed.info/sct'
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain the value '163051000000102'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Family History'
Mapping to Maternity data item = 'PSRB Heading Family History'
- subject 0..1 Mandatory Reference If all resources have the same subject
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
This is a reference to the Patient who is the subject of the list.
    Mandatory CareConnect-Patient-1 This is the subject of the Family History details List. This MUST use the CareConnect patient profile.See patient resource reference for information on how to populate the resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle
- date 0..1 Required dateTime When the list was prepared
This MUST contain a system date to indicate when the list was created or updated
- entry 0..* Required BackboneElement Entries in the list
The entries MUST be as per the diagram for this PRSB headings list. MUST contain a 'Encounter Resource' and/ MAY inlcude a 'FamilyMemberHistory resource'
- - date 0..1 Required dateTime When item added to list
The SHOULD contain a system time of when the item was added to the list.
- - item 1..1 Mandatory Reference Actual entry
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
A references to Organization, Practice and Flag resources MAY be included in the list. These MUST use the CareConnect profiles.
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL The reference to the included CareConnect resource.

Mapping for Family History Encounter

> Level 1 Encounter Resource > Level 2 CareConnect-Encounter-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
Encounter     An interaction during which services are provided to the patient
Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources
Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative
Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1'
- identifier 0..* Required Identifier Identifier(s) by which this encounter is known
An identifier for this Encounter
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - value 1..1 Required String The value that is unique
An identifier for this Encounter
- status 1..1 Mandatory Code planned : arrived : triaged : in-progress : onleave : finished : cancelled +
Binding (required): Current state of the encounter EncounterStatus
The status of the Encounter MUST contain the value 'finished'
- location 0..1 Required BackboneElement List of locations where the patient has been
- - location 1..1 Mandatory Reference Location the encounter takes place
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
The ODS/ORD Site Code of where the Family History was recorded
    Mandatory CareConnect-Location-1 The location
This MUST use the CareConnect Location profile. See Location resource for information on how to populate the resource.”
- - - reference 1..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the Location resource included in the Family History details list

Patient Reference

The Plan and requested actions List has a mandated subject reference to the Patient resource. This means that any exchange of the Plan and requested actions heading data must also include the Patient demographics List.

Mapping for Family History Family Member History

> Level 1 FamilyMemberHistory Resource > Level 2 CareConnect-FamilyMemberHistory-1 Profile > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description/Constraints
- id 0..1 Optional Id Logical id of this artifact
-meta 0..1 Mandatory Meta Metadata about the resource
- identifier 0..* Required Identifier External Id(s) for this record
An identifier for this FamilyMemberHistory
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - value 1..1 Required String The value that is unique
An identifier for this FamilyMemberHistory
- patient 1..1 Mandatory Reference ( CareConnect-Patient-1 ) Patient history is about
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- date 0..1 Mandatory dateTime When history was captured/updated The date the Family History was recorded
- relationship 1..1 Required CodeableConcept Relationship to the subject
Binding (example): The nature of the relationship between the patient and the related person being described in the family member history. ( http://hl7.org/fhir/stu3/v3/FamilyMember/vs.html )
The relationship of the person with the condition to the mother
- - - system 1..1 Mandatory Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - code 1..1 Mandatory Code Symbol in syntax defined by the system
A SNOMED CT from the Person in the family concept
- - - display 1..1 Mandatory String Representation defined by the system
The display associated with the SNOMED CT concept. This SHOULD be the preferred term
- note 0..* Optional Annotation General note about related person
Any further textual comment.
- - text 1..1 Mandatory String The annotation - text content
- condition 0..* Mandatory BackboneElement Condition that the related person had
The condition or diagnosis in family relations deemed to be significant to the care or health of the mother.
- - code 1..1 Mandatory CodeableConcept Condition suffered by relation
Binding (example): Identification of the Condition or diagnosis. ( http://hl7.org/fhir/stu3/valueset-condition-code.html )
- - - coding (snomedCT) 0..1 Required Coding Code defined by a terminology system
A concept from the Family history of clinical finding concept
- - - - system 1..1 Mandatory Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - - code 1..1 Mandatory Code Symbol in syntax defined by the system
A SNOMED CT from theFamily history of clinical finding as defined above
- - - - display 1..1 Mandatory String Representation defined by the system
he display associated with the SNOMED CT concept. This SHOULD be the preferred term

Mapping for Family History Location

The Family History details has reference(s) to the Location resource. This means that any exchange of the family history details heading data must also include the Location Details

Example of Family History

Tags: fhir