The FHIR profiles used for the Plan and requested actions List

Heading Description

This heading gives details of planned investigations, procedures and treatment for a woman’s identified conditions and priorities.

The following FHIR profiles are used to form the Plan and requested actions List structure:

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

Plan and Requested Actions Structure

Page-1 Practitioner Resource Practitioner Resource PractitionerResource Reference from Plan and requested actions List to CarePlan Reference from Encounter to Location Encounter Resource Encounter Resource EncounterResource PractitionerRole Resource PractitionerRole Resource PractitionerRoleResource Reference from CarePlan to Encounter Location Resource Location Resource LocationResource Reference from PractitionerRole to Practitioner Reference from CarePlan to Practitioner Reference from Encounter to RelatedPerson 0..1 R context 0..1 R context 0..1 Rcontext 0..* R entry.item 0..* R entry.item 0..* Rentry.item 0..1 R practitioner 0..1 R practitioner 0..1 Rpractitioner 0..1 R author 0..1 R author 0..1 Rauthor 0..1 R participant 0..1 R participant 0..1 Rparticipant 0..1 R location 0..1 R location 0..1 Rlocation CarePlan Resource CarePlan Resource CarePlanResource RelatedPerson Resource RelatedPerson Resource RelatedPersonResource Plan and requested actions List resource Plan and Requested Actions List Resource Plan and Requested ActionsList 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 Plan and requested actions List to Patient

Maternity data standard Mapping to FHIR profiles

Mapping Overview

Data Standard Element FHIR Resource Mapping FHIR Element
Date/time Encounter period.start
ODS/ORD Site Code Location identifier
SDS Job Role Name PractitionerRole code
Professional Name Practitioner name
Status (of professional plan) CarePlan status (values may require discussion)
Type (of professional plan) CarePlan category (values tbc)
Plan due date CarePlan period.start
Plan details CarePlan description
Date Plan agreed CarePlan activity.detail.scheduledPeriod.start
Actions CarePlan description
Recipient RelatedPerson relationship

Mapping for Plan and Requested Actions 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 Plan and requested actions 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 Plan and requested actions 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 'Plan and requested actions'
Mapping to Maternity data item = 'PSRB Heading Plan and requested actions'
- 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 '887201000000105'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Plan and requested actions'
Mapping to Maternity data item = 'PSRB Heading Plan and requested actions'
- 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 Plan and requested actions 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 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
This MUST use the CareConnect CarePlan profile.

See CarePlan 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 CarePlan resource.

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 Plan and Requested Actions 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
Mapping to Digital Maternity data item 'Status'
Valueset may need to be mapped.
- 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 'Type'
Valueset tbc
- - 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 1..1 Mandatory String Summary of nature of plan
Mapping to Digital Maternity Plan details and Actions
- 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 0..1 Required Reference Created in context of
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Required CareConnect-Encounter-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
- 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 Plan due date
- - end 0..1 Optional dateTime End time with inclusive boundary, if not ongoing
- author 0..1 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
- 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..* Optional 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
- - - - 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
- - - scheduled[x] 1..1 Mandatory Timing When activity is to occur
    Mandatory Period Period.start has mapping to Digital Maternity data item 'Date Plan agreed'
- - - 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..* Optional Annotation Comments about the plan
- - 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 0..1 Optional dateTime When the annotation was made
- - text 1..1 Optional String The annotation - text content

Mapping for Plan and Requested Actions 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 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
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 planned : arrived : triaged : in-progress : onleave : finished : cancelled +
Binding (required): Current state of the encounter EncounterStatus
- subject 0..1 Optional Reference The patient ro group present at the encounter
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
- participant 0..1 Required BackboneElement List of participants involved in the encounter
- - type 0..* Required CodeableConcept Role of participant in encounter
Binding (extensible): Role of participant in encounter ParticipantType
- - - coding 0..* Required Coding Code defined by a terminology system
- - - - system 0..1 Required Uri Identity of the terminology system
- - - - code 0..1 Required Code Symbol in syntax defined by the system
- - - - display 0..1 Required 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
- - period 0..1 Optional Period Period of time during the encounter that the participant participated
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
- - individual 0..1 Required Reference Persons involved in the encounter other than the patient
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Required RelatedPerson  
    Optional 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 Required String Text alternative for the resource
- period 1..1 Mandatory Period The start and end time of the encounter
Constraint (per-1): If present, start SHALL have a lower value than end
- - start 1..1 Mandatory dateTime Starting time with inclusive boundary
Mapped to Digital Maternity data item 'Date/time'
- - end 0..1 Optional dateTime End time with inclusive boundary, if not ongoing
- 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
    Mandatory CareConnect-Location-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

Mapping for Plan and Requested Actions Location

The plan and requested actions details 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

Mapping for Plan and Requested Actions 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 Plan and Requested Actions 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

Mapping for Plan and Requested Actions RelatedPerson

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

Plan and Requested Actions Example

Tags: fhir