The FHIR profiles used for the Personal contacts List
Heading Description
This heading gives details of the women’s personal contacts.
The following FHIR profiles are used to form the Personal contacts List structure:
The following profiles are referenced from the Patient demographics list structure:
Personal Contacts Structure
Maternity data standard Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Resource Mapping | FHIR Element |
| Date/time | Currently not mapped | Currently not mapped |
| First given name | RelatedPerson | name.given |
| Family name | RelatedPerson | name.family |
| Contact details | RelatedPerson | telecom |
| Relationship type | RelatedPerson | relationship |
| Household member | Observation | code/value[x] (subject to appropriate national codes being available) |
| Parental responsibility | Observation | code/value[x] (subject to appropriate national codes being available) |
| Significant individual | Observation | code/value[x] (subject to appropriate national codes being available) |
Note that an approach to linking the RelatedPerson and Observation resources has not yet been finalised.
The following tables detail how to populate the FHIR resources and the mapping to the Maternity data standard.
Mapping for Personal Contacts List
| > | Level 1 | List Resource | > | Level 2 | CareConnect-List-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| List | | Information summarized from a list of other resources 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 Constraint (lst-2): The deleted flag can only be used if the mode of the list is “changes” Constraint (lst-1): A list can only have an emptyReason if it is empty |
||
| - 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-List-1' |
| - identifier | 0..* | Required | Identifier | Business identifier An identifier for this Personal contacts List |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier A value for the identifier for this Personal contacts List |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - 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 'Personal contacts' Mapping to Maternity data item = 'PSRB Heading Personal contacts' |
| - 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 'tbc' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Personal contacts' Mapping to Maternity data item = 'PSRB Heading Personal contacts' |
| - 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 Personal contacts 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 | Mandatory | dateTime | When the list was prepared This MUST contain a system date to indicate when the list was created or updated |
| - note | 0..* | Optional | Annotation | Comments about the list |
| - - author[x] | 0..1 | Optional | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | RelatedPerson | |||
| Optional | CareConnect-Patient-1 | |||
| Optional | CareConnect-Practitioner-1 | |||
| Optional | String | |||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Mandatory | String | The annotation - text content |
| - entry | 0..* | Mandatory | BackboneElement | Entries in the list The entries MUST be as per the diagram for this PRSB headings list with the RelatedPerson resource being the focal 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 | Required | Reference | Actual entry Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to a RelatedPerson resource included in the list This MUST use the CareConnect RelatedPerson profile. See RelatedPerson resource for information on how to populate the resource. |
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included RelatedPerson resource. |
Patient Reference
The Personal contacts List has a mandated subject reference to the Patient resource. This means that any exchange of the Personal contacts heading data must also include the Patient demographics List.
Mapping for Personal contacts RelatedPerson
The personal contacts details has reference(s) to the related person resource. This means that any exchange of the personal contacts details heading data must also include the Related Person Details
Mapping for Personal contacts Observation
| > | Level 1 | Observation Resource | > | Level 2 | CareConnect-Observation-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Observation | | Measurements and simple assertions 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 Constraint (obs-7): If code is the same as a component code then the value element associated with the code SHALL NOT be present Constraint (obs-6): dataAbsentReason SHALL only be present if Observation.value[x] is not present |
||
| - 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-Observation-1' |
| - identifier | 0..* | Required | Identifier | Business Identifier for observation An identifier for this Personal contacts Observation |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value The system from which the identifier came |
| - - value | 1..1 | Mandatory | String | The value that is unique |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | registered : preliminary : final : amended + Binding (required): Codes providing the status of an observation. ObservationStatus This MUST contain the value 'final' |
| - code | 1..1 | Mandatory | CodeableConcept | Type of observation (code / type) Binding (example): Codes identifying names of simple observations. LOINC Codes This example ValueSet is not used by Maternity record. Mapping to Maternity data items = 'Household member', 'Parental responsibility', 'Significant individual' (subject to appropriate national codes being available) |
| - - coding | 0..1 | Required | Coding | Code defined by a terminology system Slicing: Discriminator: code, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation CareConnect-ObservationType-1 |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system CodeSystem tbc |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system tbc |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system tbc |
| - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - subject | 0..1 | Optional | Reference | Who and/or what this is about Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Patient-1 | |||
| - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - effective[x] | 1..1 | Mandatory | dateTime | Clinically relevant time/time-period for observation |
| - performer | 0..1 | Required | Reference | Who is responsible for the observation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Required | CareConnect-Practitioner-1 | |||
| - - reference | 0..1 | Required | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - value[x] | Required | CodeableConcept | The system element MUST contain the identity of the terminology system May be mapped to Digital Maternity data item 'Household member', 'Parental responsibility' or 'Significant individual' |
|
| - value[x] | Required | String | May be mapped to Digital Maternity data item 'Household member', 'Parental responsibility' or 'Significant individual' | |
| - value[x] | Required | Boolean | May be mapped to Digital Maternity data item 'Household member', 'Parental responsibility' or 'Significant individual' |
Personal Contacts Heading Example
Note that the Observation resource is not present in the example because an approach to linking the RelatedPerson and Observation resources has not yet been finalised.