Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Professional contacts List

The FHIR profiles used for the Professional contacts List

Heading Description

The details of the woman’s professional contacts.

The following FHIR profiles are used to form the Professional contacts List structure:

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

Professional contacts Structure

Page-1 Practitioner Resource Practitioner Resource PractitionerResource Reference from Professional contacts List to EpisodeOfCare EpisodeOfCare Resource EpisodeOfCare Resource EpisodeOfCareResource PractitionerRole Resource PractitionerRole Resource PractitionerRoleResource Reference from EpisodeOfCare to CareTeam Reference from PractitionerRole to Practitioner Reference from CareTeam to Practitioner Reference from CareTeam to Organization 1..1 M team 1..1 M team 1..1 Mteam 0..* R entry.item 0..* R entry.item 0..* Rentry.item 0..1 R practitioner 0..1 R practitioner 0..1 Rpractitioner 1..1 M managing Organization 1..1 M managing Organization 1..1 MmanagingOrganization 0..1 R participant 0..1 R participant 0..1 Rparticipant CareTeam Resource CareTeam Resource CareTeamResource Organization Resource Organization Resource OrganizationResource Professional contacts List Resource Professional contacts List Resource Professional contactsList 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 Professional contacts List to Patient

Maternity data standard Mapping to FHIR profiles

Mapping Overview

Data Standard Element FHIR Resource Mapping FHIR Element
Organisation Organization identifier
Team CareTeam name
Name Practitioner name
Role PractitionerRole code
CareSetting   unmapped
Keyworker CareTeam participant.role
Care Professional Association   unmapped
Contact details Organization/Practitioner telecom
Start date CareTeam period.start
End date CareTeam period.end
Reason   unmapped

Mapping for Professional 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 Professional 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
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
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 'Professional contacts'
Mapping to Maternity data item = 'PSRB Heading Professional 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 'Professional contacts'
Mapping to Maternity data item = 'PSRB Heading Professional 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 Professional 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 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 EpisodeOfCare 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 an EpisodeOfCare resource included in the list
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL

Mapping for Professional contacts EpisodeOfCare

> Level 1 EpisodeOfCare Resource > Level 2 CareConnect-EpisodeOfCare-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
EpisodeOfCare     An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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 1..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-EpisodeOfCare-1'
- identifier 0..* Required Identifier Business Identifier(s) relevant for this EpisodeOfCare
- - system 0..1 Required Uri The namespace for the identifier value
- - value 0..1 Required 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 planned : waitlist : active : onhold : finished : cancelled : entered-in-error
Binding (required): The status of the episode of care. EpisodeOfCareStatus
This MUST contain the value 'finished'
- type 0..* Optional CodeableConcept Type/class - e.g. specialist referral, disease management
Binding (example): The type of the episode of care EpisodeOfCareType
- - coding 0..* Optional Coding Code defined by a terminology system
- - - system 0..1 Optional Uri Identity of the terminology system
- - - version 0..1 Optional String Version of the system - if relevant
- - - 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
- patient 1..1 Mandatory Reference The patient who is the focus of this episode of care
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 EpisodeOfCare.
    Mandatory CareConnect-Patient-1 This is the subject of the Episode of Care.This MUST use the CareConnect patient profile.
- - 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 Optional Identifier Logical reference, when literal reference is not known
- - display 0..1 Optional String Text alternative for the resource
- managingOrganization 0..1 Required Reference Organization that assumes care
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Required CareConnect-Organization-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

Mapping for Professional contacts CareTeam

> Level 1 CareTeam Resource > Level 2 CareConnect-CareTeam-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
CareTeam     Planned participants in the coordination and delivery of care for a 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-CareTeam-1'
- identifier 0..* Required Identifier External Ids for this team
An identifier for this CareTeam
- - 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
- - 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
- status 0..1 Optional Code proposed : active : suspended : inactive : entered-in-error
Binding (required): Indicates the status of the care team. CareTeamStatus
- category 0..* Optional CodeableConcept Type of team
Binding (example): Indicates the type of care team. CareTeamCategory
- - coding 0..* Optional Coding Code defined by a terminology system
- - - system 0..1 Optional Uri Identity of the terminology system
- - - version 0..1 Optional String Version of the system - if relevant
- - - 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
- name 0..1 Required String Name of the team, such as crisis assessment team
Mapped to Digital Maternity data item 'Name'
- subject 0..1 Optional Reference Who care team is for
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
- context 0..1 Optional Reference Encounter or episode associated with CareTeam
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-EpisodeOfCare-1  
    Optional CareConnect-Encounter-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
- period 0..1 Required Period Time period team covers
Constraint (per-1): If present, start SHALL have a lower value than end
- - start 0..1 Required dateTime Starting time with inclusive boundary
Mapping to Digital Maternity data item='Start date'
- - end 0..1 Required dateTime End time with inclusive boundary, if not ongoing
Mapping to Digital Maternity data item='End date'
- participant 0..* Required BackboneElement Members of the team
Constraint (ctm-1): CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
- - role 0..1 Optional CodeableConcept Type of involvement
Binding (example): Indicates specific responsibility of an individual within the care team, such as “Primary physician”, “Team coordinator”, “Caregiver”, etc. Participant Roles
Mapping to Digital Maternity data item='Keyworker'
- - - 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
- - member 0..1 Required Reference Who is involved
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
    Optional CareConnect-Patient-1  
    Required CareConnect-Practitioner-1  
    Optional CareConnect-RelatedPerson-1  
    Optional CareConnect-CareTeam-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
- - onBehalfOf 1..1 Mandatory Reference Organization of the practitioner
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Organization-1  
- - - reference 1..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 0..1 Optional Period Time period of participant
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
- managingOrganization 1..1 Mandatory Reference Organization responsible for the care team
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Organization-1  
- - reference 1..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
- note 0..* Optional Annotation Comments made about the CareTeam
- - 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 Mandatory String The annotation - text content

Mapping for Professional contacts Practitioner

The Professional contacts List has reference(s) to the Practitioner resource. This means that any exchange of the Professional contacts List heading data must also include the Practitioner Details

Mapping for Professional contacts PractitionerRole

The Professional contacts List has reference(s) to the Practitioner Role resource. This means that any exchange of the Professional contacts List heading data must also include the Practitioner Role Details

Mapping for Professional contacts Organization

The Professional contacts List has reference(s) to the Organization resource. This means that any exchange of the Professional contacts List heading data must also include the Organization Details

Professional contacts example

Tags: fhir

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