The FHIR profiles used for the Personal comment List
Heading Description
This heading gives details of any comment recorded by the woman or her representative.
The following FHIR profiles are used to form the Personal comment List structure:
- CareConnect-List-1
- CareConnect-Observation-1
- CareConnect-Practitioner-1
- CareConnect-PractitionerRole-1
The following profiles are referenced from the Patient demographics list structure:
Personal Comment Structure
Maternity data standard Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Resource Mapping | FHIR Element |
| Date/time | Observation | effectiveDateTime |
| Name | Practitioner | name |
| Details | Observation | valueString |
| Relationship status | PractitionerRole | code |
The following tables detail how to populate the FHIR resources and the mapping to the Maternity data standard.
Mapping for Personal comment 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' |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. Common Languages |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (clinicalSetting) | 0..1 | Not Used | Extension-CareConnect-ClinicalSetting-1 | To record the clinical setting of a problem list Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (warningCode) | 0..1 | Not Used | Extension-CareConnect-ListWarningCode-1 | To capture warnings that the list may be incomplete Constraint (ext-1): Must have either extensions or value[x], not both |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - identifier | 0..* | Required | Identifier | Business identifier An identifier for this Personal comment list |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - 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 An identifier for this Personal comment list |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Required | String | Text alternative for the resource The organization that allocated the identifier |
| - 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 comment' Mapping to Maternity data item = 'PSRB Heading Personal comment' |
| - 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' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant Mapping to Maternity Data item Not applicable |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system tbc |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Personal comment' Mapping to Maternity data item = 'PSRB Heading Personal comment' |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - 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. |
| Not Used | Group | |||
| Not Used | Device | |||
| Mandatory | CareConnect-Patient-1 | This is the subject of the Personal comment List. This MUST use the CareConnect patient profile. See patient resource reference for information on how to populate the resource. |
||
| Not Used | CareConnect-Location-1 | |||
| - - 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 |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - encounter | 0..1 | Not Used | Reference | Context in which list created Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Encounter-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - date | 0..1 | Mandatory | dateTime | When the list was prepared This MUST contain a system date to indicate when the list created or updated |
| - source | 0..1 | Not Used | Reference | Who and/or what defined the list contents (aka Author) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Device | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - orderedBy | 0..1 | Not Used | CodeableConcept | What order the list has Binding (preferred): What order applies to the items in a list List Order Codes |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - note | 0..* | Optional | Annotation | Comments about the list |
| - - author[x] | 0..1 | Not Used | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | RelatedPerson | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-1 | |||
| Required | String | Who authored the comment on the list. | ||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Required | 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 Observation resource being the focal resource. |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - flag | 0..1 | Not Used | CodeableConcept | Status/Workflow information about this item Binding (example): Codes that provide further information about the reason and meaning of the item in the list Patient Medicine Change Types |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - deleted | 0..1 | Not Used | Boolean | If this item is actually marked as deleted Default Value: false |
| - - 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 an Observation resource included in the list. This MUST use the CareConnect Observation profile. See Observation resource for information on how to populate the resource. |
| Not Used | Resource | |||
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included Observation resource. |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - emptyReason | 0..1 | Not Used | CodeableConcept | Why list is empty Binding (preferred): If a list is empty, why it is empty CareConnect-ListEmptyReasonCode-1 |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
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 comment 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..* | Optional | Identifier | Business Identifier for 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 An identifier for this Personal comment Observation |
| - - 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 Valueset tbc |
| - - 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 Mapping to Digital Maternity data item 'Date/time' |
| - 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 | String | Mapping to Digital Maternity data item 'Details' |
Mapping for Personal comment Practitioner
The plan and requested actions details has reference(s) to the Practitioner resource. This means that any exchange of the plan and requested actions details heading data must also include the Practitioner Details
Mapping for Personal comment PractitionerRole
The plan and requested actions details has reference(s) to the Practitioner Role resource. This means that any exchange of the plan and requested actions details heading data must also include the Practitioner Role Details