Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Person concerns List

The FHIR profiles used for the Person concerns List

Heading Description

Details of the woman’s concerns, expectations and wishes.

The following FHIR profiles are used to form the Person concerns List structure:

The following profiles are referenced from the Patient demographics list structure:

Person concerns Structure

Page-1 CarePlan Resource CarePlan Resource CarePlanResource Reference from Person concerns List to CarePlan 0..* R entry.item 0..* R entry.item 0..* Rentry.item Person concerns List Resource Person concerns List Resource Person concernsList Resource 1..1 M subject 1..1 M subject 1..1 Msubject Reference to Patient resource Reference to Patient resource Reference to Patient resource Reference from Person concerns List to Patient Reference from CarePlan to patient 1..1 M subject 1..1 M subject 1..1 Msubject Contract Resource Contract Resource ContractResource Reference from CarePlan to Contract 0..1 R Supporting Information 0..1 R Supporting Information 0..1 RSupportingInformation Location Resource Location Resource LocationResource Reference from CarePlan to Location 0..1 R activity. detail.location 0..1 R activity. detail.location 0..1 Ractivity.detail.location

Maternity data standard Mapping to FHIR profiles

Mapping Overview

Data Standard Element FHIR Resource Mapping FHIR Element
Date/time CarePlan period.start/note.time
Concern, wishes or goals details CarePlan goal/note
Maternity Care Plan Type CarePlan category
Planned delivery setting Location type
Reason for change of planned delivery setting CarePlan activity.detail.reasonCode
Advance Statement Date Contract meta.lastUpdated
Advance Statement Details Contract text
Location of Advance Statement Document   unmapped

Mapping for Person concerns 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 Person concerns 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
A value for the identifier
- - 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
- 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 'Person concerns'
Mapping to Maternity data item = 'PSRB Heading Person concerns'
- 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 'Person concerns'
Mapping to Maternity data item = 'PSRB Heading Person concerns'
- 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 Person concerns 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 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 CareConnect-Practitioner-1  
    Optional 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 CarePlan 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 CarePlan resource included in the list
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL

Patient Reference

The Person concerns 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 Person concerns CarePlan

> Level 1 CarePlan Resource > Level 2 CareConnect-CarePlan-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
CarePlan     Healthcare plan for patient or group
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-CarePlan-1'
- identifier 0..* Required Identifier External Ids for this plan
An identifier for this Plan and requested actions CarePlan
- - system 0..1 Required Uri The namespace for the identifier value
The system from which the identifier came
- - value 0..1 Required String The value that is unique
A value for the identifier for this Plan and requested actions CarePlan
- - 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
- basedOn 0..* Optional Reference Fulfills care plan
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-CarePlan-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
- replaces 0..* Optional Reference CarePlan replaced by this CarePlan
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-CarePlan-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
- partOf 0..* Optional Reference Part of referenced CarePlan
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-CarePlan-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 draft : active : suspended : completed : entered-in-error : cancelled : unknown
Binding (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. CarePlanStatus
- intent 1..1 Mandatory Code proposal : plan : order : option
Binding (required): Codes indicating the degree of authority/intentionality associated with a care plan CarePlanIntent
- category 1..1 Mandatory CodeableConcept Type of plan
Binding (example): Identifies what “kind” of plan this is to support differentiation between multiple co-existing plans; e.g. “Home health”, “psychiatric”, “asthma”, “disease management”, etc. Care Plan Category
Mapping to Digital Maternity data item 'Maternity care plan type'
Valueset Care Plan Type
- - coding 0..* Mandatory Coding Code defined by a terminology system
- - - system 0..1 Mandatory Uri Identity of the terminology system
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - display 0..1 Mandatory String Representation defined by the system
- - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - text 0..1 Optional String Plain text representation of the concept
- title 0..1 Optional String Human-friendly name for the CarePlan
- description 0..1 Optional String Summary of nature of plan
- subject 1..1 Mandatory Reference Who care plan is for
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Patient-1  
- - reference 0..1 Mandatory 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
context 1..1 Mandatory Reference Created in context of
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Encounter-1  
- - reference 0..1 Mandatory 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
- period 1..1 Mandatory Period Time period plan covers
Constraint (per-1): If present, start SHALL have a lower value than end
- - start 1..1 Mandatory dateTime Starting time with inclusive boundary
Mapping to Digital Maternity data item 'Date/time'
- - end 0..1 Optional dateTime End time with inclusive boundary, if not ongoing
- author 0..* Required Reference Who is responsible for contents of the plan
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
- goal 0..* Required Reference Desired outcome of plan
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
Mapping to Digital Maternity data item 'Concern, wishes or goal details'
    Required Goal  
- - 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
- activity 0..* Required BackboneElement Action to occur as part of plan
Constraint (cpl-3): Provide a reference or detail, not both
- - outcomeCodeableConcept 0..* Optional CodeableConcept Results of the activity
Binding (example): Identifies the results of the activity Care Plan Activity Outcome
- - - coding 0..* Optional Coding Code defined by a terminology system
- - - - system 0..1 Optional Uri Identity of the terminology system
- - - - code 0..1 Optional Code Symbol in syntax defined by the system
- - - - display 0..1 Optional String Representation defined by the system
- - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - text 0..1 Optional String Plain text representation of the concept
- - outcomeReference 0..* Optional Reference Appointment, Encounter, Procedure, etc.
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional Resource  
- - - 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
- - - category 0..1 Optional CodeableConcept diet : drug : encounter : observation : procedure : supply : other
Binding (example): High-level categorization of the type of activity in a care plan. CarePlanActivityCategory
- - - - coding 0..* Optional Coding Code defined by a terminology system
- - - - - system 0..1 Optional Uri Identity of the terminology system
- - - - - code 0..1 Optional Code Symbol in syntax defined by the system
- - - - - display 0..1 Optional String Representation defined by the system
- - - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - - text 0..1 Optional String Plain text representation of the concept
- - - code 0..1 Optional CodeableConcept Detail type of activity
Binding (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Care Plan Activity
- - - - coding 0..* Optional Coding Code defined by a terminology system
- - - - - system 0..1 Optional Uri Identity of the terminology system
- - - - - code 0..1 Optional Code Symbol in syntax defined by the system
- - - - - display 0..1 Optional String Representation defined by the system
- - - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - - text 0..1 Optional String Plain text representation of the concept
- - - reasonCode 0..* Required CodeableConcept Why activity should be done or why activity was prohibited
Binding (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as “general wellness”, prophylaxis, surgical preparation, etc. Activity Reason
Mapping to Digital Maternity data item 'Reason for change of planned delivery setting'
- - - - coding 0..* Optional Coding Code defined by a terminology system
- - - - - system 0..1 Optional Uri Identity of the terminology system
- - - - - code 0..1 Optional Code Symbol in syntax defined by the system
- - - - - display 0..1 Optional String Representation defined by the system
- - - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - - text 0..1 Optional String Plain text representation of the concept
- - - reasonReference 0..* Optional Reference Condition triggering need for activity
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Condition-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 Optional Code not-started : scheduled : in-progress : on-hold : completed : cancelled : unknown
Binding (required): Indicates where the activity is at in its overall life cycle. CarePlanActivityStatus
- - - statusReason 0..1 Optional String Reason for current status
- - - prohibited 0..1 Optional Boolean Do NOT do
Default Value: false
    Mandatory Period  
- - - location 0..1 Optional Reference Where it should happen
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Location-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
- - - performer 0..* Optional Reference Who will be responsible?
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
    Optional CareConnect-Patient-1  
    Optional CareConnect-Practitioner-1  
    Optional CareConnect-CareTeam-1  
    Optional CareConnect-RelatedPerson-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
- - - product[x] 0..1 Optional CodeableConcept What is to be administered/supplied
Binding (example): A product supplied or administered as part of a care plan activity. SNOMED CT Medication Codes
    Optional Reference  
    Optional Substance  
    Optional CareConnect-Medication-1  
- - - dailyAmount 0..1 Optional Quantity (SimpleQuantity) How to consume/day?
Constraint (qty-3): If a code for the unit is present, the system SHALL also be present
Constraint (sqty-1): The comparator is not used on a SimpleQuantity
- - - - value 0..1 Optional Decimal Numerical value (with implicit precision)
- - - - unit 0..1 Optional String Unit representation
- - - - system 0..1 Optional Uri System that defines coded unit form
- - - - code 0..1 Optional Code Coded form of the unit
- - - quantity 0..1 Optional Quantity (SimpleQuantity) How much to administer/supply/consume
Constraint (qty-3): If a code for the unit is present, the system SHALL also be present
Constraint (sqty-1): The comparator is not used on a SimpleQuantity
- - - - value 0..1 Optional Decimal Numerical value (with implicit precision)
- - - - unit 0..1 Optional String Unit representation
- - - - system 0..1 Optional Uri System that defines coded unit form
- - - - code 0..1 Optional Code Coded form of the unit
- - - description 0..1 Optional String Extra info describing activity to perform
- note 0..* Required Annotation Comments about the plan
Mapping to Digital Maternity data item 'Concern, wishes or goal details'
- - author[x] 0..1 Optional String Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional Reference  
    Optional CareConnect-Patient-1  
    Optional CareConnect-Practitioner-1  
    Optional CareConnect-RelatedPerson-1  
- - time 1..1 Mandatory dateTime When the annotation was made
Mapping to Digital Maternity data item 'Date/time'
- - text 1..1 Mandatory String The annotation - text content

Mapping for Person concerns Contract

> Level 1 Contract Resource > Level 2 CareConnect-Contract-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
Contract     Legal Agreement
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-CarePlan-1'
The lastUpdated element maps to Digital Maternity data item = 'Advance Statement date'
- text 0..1 Required Narrative Text summary of the resource, for human interpretation
Mapping to Digital Maternity data item = 'Advance statement details'
- identifier 0..1 Required Identifier Contract number
An identifier for this Person concerns Contract
- - 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 0..1 Optional Code amended : appended : cancelled : disputed : entered-in-error : executable : executed : negotiable : offered : policy : rejected : renewed : revoked : resolved : terminated
Binding (required): A code specifying the state of the resource instance. Contract Resource Status Codes
- issued 0..1 Optional dateTime When this Contract was issued
- applies 0..1 Optional Period Effective time
Constraint (per-1): If present, start SHALL have a lower value than end
- - start 0..1 Optional dateTime Starting time with inclusive boundary
- - end 0..1 Optional dateTime End time with inclusive boundary, if not ongoing
- subject 0..* Optional Reference Contract Target Entity
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional Resource  
- - 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
- topic 0..* Optional Reference Context of the Contract
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional Resource  
- - 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
- authority 0..* Optional Reference Authority under which this Contract has standing
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

Mapping for Person concerns Location

The Person concerns List has reference(s) to the Location resource. This means that any exchange of the plan and requested actions details heading data must also include the Location Details

Person concerns example

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated