The FHIR profiles used for the Attendance details List
Heading Description
The details of the woman’s contact with services.
The following FHIR profiles are used to form the Attendance details list structure:
- CareConnect-List-1
- CareConnect-Encounter-1
- CareConnect-Communication-1
- CareConnect-EpisodeOfCare-1
- CareConnect-Practitioner-1
- CareConnect-PractitionerRole-1
- CareConnect-Location-1
The following profiles are referenced from the Attendance details list structure:
Attendance Details Structure
Maternity Data Standard Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Profile Mapping | FHIR Element |
| Date/Time | List | period |
| ODS/ORD Site Code | Location | identifier |
| Location Type | Encounter | class |
| Professional Name | Practitioner | name |
| SDS Job Role Name | PractitionerRole | identifier |
| Contact type | Encounter | type |
| Consultation method | Communication | medium |
| Care setting | Location | type |
| Service | EpisodeOfCare | type |
| Care professional present (name) | Practitioner | name |
| Care professional present (role) | PractitionerRole | role |
| Care professionals present type | Encounter | participant.type |
| First Given Name | RelatedPerson | name |
| Family Name | RelatedPerson | name |
| Relationship of person accompanying patient | Encounter | participant.type |
| Outcome of contact | OutcomeOfAttendance extension | Currently not mapped due to “required” ValueSet issues |
Mapping for Attendance Details 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 Attendance details list |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier An identifier for this Attendance details list |
| - - - 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 'Attendance details' Mapping to Maternity data item = 'PSRB Heading Attendance details' |
| - 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 '1077881000000105' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Attendance details' Mapping to Maternity data item = 'PSRB Heading Attendance details' |
| - 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 Attendance details 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 |
| 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 encounter resource being the focal resource. Multiple Encounters with associated resources MAY be present |
| - - date | 0..1 | Required | dateTime | When item added to list This 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 Encounter resource included in the list This MUST use the CareConnect Encounter profile. See Encounter 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 Encounter resource. |
Mapping for Attendance Details 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' |
| - extension (outcomeOfAttendance) | 0..1 | Required | Extension-CareConnect-OutcomeOfAttendance-1 | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. Constraint (ext-1): Must have either extensions or value[x], not both This item is currently not mapped due to issues with the required ValueSet |
| - identifier | 0..* | Required | Identifier | Identifier(s) by which this encounter is known An identifier for this Encounter |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Required | String | The value that is unique An identifier for this Attendance details encounter |
| - - - display | 0..1 | Required | 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 The status of the Encounter MUST contain the value 'finished' |
| - class | 0..1 | Required | Coding | Classification of the encounter Binding (extensible): Classification of the encounter ActEncounterCode |
| - - 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 |
| - type | 0..1 | Required | CodeableConcept | Specific type of encounter Binding (example): The type of encounter EncounterType |
| - - coding | 0..1 | Required | Coding | The example MUST not be used the following ValueSet MUST be used instead Care Contact Type |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system |
| - - - code | 1..1 | Required | Code | Symbol in syntax defined by the system |
| - - - display | 1..1 | Required | String | Representation defined by the system |
| - participant | 0..* | Required | BackboneElement | List of participants involved in the encounter Mapping to Maternity data item = 'Care professionals present' , 'Person accompanying patient' and 'Professional performing the contact' |
| - - type | 0..* | Required | CodeableConcept | Role of participant in encounter Binding (extensible): Role of participant in encounter ParticipantType There will be several instances of this element. The first use case is for Care professionals present and performing professional which will use a reference to the Practitioner resource and the second use case is for Person accompanying patient and this will use a reference to the RelatedPerson resource Mapping to Maternity data item ='Care professionals present type' , 'Professional performing the contact' and 'Relationship of Person accompanying patient' |
| - - - coding | 1..1 | Mandatory | Coding | Code defined by a terminology system There will be one instance of the coding for each instance of type |
| - - - - system | 1..1 | Mandatory | Uri | |
| Identity of the terminology system | ||||
| - - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system The Care professionals present will use the most appropriate code the performing professional will use a code of 'PPRF'. The Person accompanying patient will use a code of 'ESC' |
| - - - - display | 1..1 | Mandatory | String | Code defined by a terminology system The Care professional will use the display of 'primary performer' The Person accompanying patient will use a display of 'escort' |
| - - individual | 1..1 | Mandatory | Reference | Persons involved in the encounter other than the patient Constraint (ref-1): SHALL have a contained resource if a local reference is provided This MUST be a reference to either the Practitioner or RelatedPerson resource |
| Required | RelatedPerson | The person accompanying the patient. This MUST use the RelatedPerson resource. See RelatedPerson resource for information on how to populate the resource. |
||
| Required | CareConnect-Practitioner-1 | Care Professionals present during the encounter. This MUST use the CareConnect Practitioner profile. See Practitioner resource for information on how to populate the resource. |
||
| - - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the RelatedPerson resource or the Practitioner resource included in the Attendance details list |
| - 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 The site code of the unit to which the person was admitted |
| Mandatory | CareConnect-Location-1 | The location This MUST use the CareConnect Location profile. See Location resource for information on how to populate the resource.” |
||
| - - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the Location resource included in the Attendance details list |
Patient Reference
The Admission details list has a mandated subject reference to the Patient resource. This means that any exchange of the Admission details heading data must also include the Patient demographics List.
Mapping for Attendance Details Communication
| > | Level 1 | Communication Resource | > | Level 2 | CareConnect-Communication-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description/Constraints |
|---|---|---|---|---|
| Communication | | A record of information transmitted from a sender to a receiver 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 (com-1): Not Done Reason can only be specified if NotDone is “true” |
||
| - 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-Communication-1' |
| - identifier | 0..* | Required | Identifier | Unique identifier |
| - - system | 0..1 | Required | Uri | The namespace for the identifier value |
| - - value | 0..1 | Required | String | The value that is unique |
| - medium | 0..* | Mandatory | CodeableConcept | A channel of communication Binding (example): Codes for communication mediums such as phone, fax, email, in person, etc. Participation-Mode This example ValueSet MUST not be used the follow ValueSet from NHS Data Dictionary should be used instead CONSULTATION MEDIUM USED Mapping to Maternity data item = 'Consultation method' |
| - - coding | 0..* | Required | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Required | Uri | Identity of the terminology system This MUST contain the value 'https://www.datadictionary.nhs.uk' |
| - - - code | 0..1 | Required | Code | Symbol in syntax defined by the system The code MUST be from the stated ValueSet |
| - - - display | 0..1 | Required | String | Representation defined by the system The display MUST be the text associated with the code |
Mapping for Attendance Details 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 |
| - 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 | 1..1 | Mandatory | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding (example): The type of the episode of care EpisodeOfCareType This example ValueSet MUST NOT be used. The Data Dictionary SERVICE ValueSet should be used instead. Mapping to Maternity data item = 'Service' |
| - - 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 |
| - 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. 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. |
Mapping for Attendance Details Location
The attendance details scales details has reference(s) to the Location resource. This means that any exchange of the attendance details heading data must also include the Location Details.
Mapping for Attendance Details Practitioner
The attendance details has reference(s) to the Practitioner resource. This means that any exchange of the attendance details heading data must also include the Practitioner Details.
Mapping for Attendance Details PractitionerRole
The attendance details has reference(s) to the Practitioner Role resource. This means that any exchange of the attendance details heading data must also include the Practitioner Role Details.