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' |
| - 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 Attendance details 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 from |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier An identifier for this Attendance details 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 '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' |
| - - - 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 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' |
| - - - 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 Attendance details 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 A reference to the encounter resource within the Attendance details list. |
| Not Used | CareConnect-Encounter-1 | This is the context of the Attendance details List. This MUST use the CareConnect encounter profile. See encounter resource for information on how to populate the resource. |
||
| - - 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 was 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 encounter resource being the focal resource. Multiple Encounters with associated resources MAY be present |
| - - 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 Encounter resource included in the list This MUST use the CareConnect Encounter profile. See Encounter 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 Encounter 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 |
Mapping for Attendance Details Encounter
| > | Level 1 | Encounter Resource | > | Level 2 | [CareConnect-Encounter-1(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | > | Level 3 | None |
| 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' |
| - 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 (encounterTransport) | 0..1 | Not Used | Extension-CareConnect-EncounterTransport-1 | Encounter transport Constraint (ext-1): Must have either extensions or value[x], not both |
| - 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 |
| - extension (emergencyCareDischargeStatus) | 0..1 | Not Used | Extension-CareConnect-EmergencyCareDischargeStatus-1 | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. 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 | Identifier(s) by which this encounter is known An identifier for this Encounter |
| - - 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 from |
| - - value | 1..1 | Required | String | The value that is unique An identifier for this Attendance details encounter |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 |
| - 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' |
| - statusHistory | 0..* | Not Used | BackboneElement | List of past encounter statuses |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - status | 1..1 | Not Used | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled + Binding (required): Current state of the encounter EncounterStatus |
| - - period | 1..1 | Not Used | Period | The time that the episode was in the specified status Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 |
| - 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 |
| - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - 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 | Not Used | Boolean | If this coding was chosen directly by the user |
| - classHistory | 0..* | Not Used | BackboneElement | List of past encounter classes |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - class | 1..1 | Not Used | Coding | Classification of the encounter Binding (extensible): Classification of the encounter ActEncounterCode |
| - - - 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 |
| - - period | 0..1 | Not Used | Period | The time that the episode was in the specified class Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 |
| - type | 0..1 | Required | CodeableConcept | Specific type of encounter Binding (example): The type of encounter EncounterType |
| - - coding | 0..1 | Required | Coding | The example ValueSet MUST not be used, the following ValueSet MUST be used instead Care Contact Type |
| - - coding (snomedCT) | 0..* | Not Used | Coding | Code defined by a terminology system Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient’s record). CareConnect-EncounterType-1 |
| - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 1..1 | Required | Code | Symbol in syntax defined by the system |
| - - - display | 1..1 | Required | 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 |
| - priority | 0..1 | Not Used | CodeableConcept | Indicates the urgency of the encounter Binding (example): Indicates the urgency of the encounter. v3 Code System ActPriority |
| - - 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 |
| - subject | 0..1 | Not Used | Reference | The patient or group present at the encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Group | |||
| Not Used | CareConnect-Patient-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 |
| - episodeOfCare | 0..* | Not Used | Reference | Episode(s) of care that this encounter should be recorded against Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | EpisodeOfCare | |||
| - - 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 |
| - incomingReferral | 0..* | Not Used | Reference | The ReferralRequest that initiated this encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | ReferralRequest | |||
| - - 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 |
| - participant | 0..* | Required | BackboneElement | List of participants involved in the encounter Mapping to Maternity data item = 'Care professionals present' and 'Person accompanying patient' |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - type | 0..* | Required | CodeableConcept | Role of participant in encounter Binding (extensible): Role of participant in encounter ParticipantType There will be serveral instances of this element. The first use case is for Care professionals present and this 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' 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 This MUST contain the value 'http://hl7.org/fhir/ValueSet/encounter-participant-type' |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system The Care professionals present will use the most appropriate code. The Person accompanying patient will use a code of 'ESC' |
| - - - - display | 1..1 | Mandatory | String | The Care professional will use the display associated with the code The Person accompanying patient will use a display of 'escort' |
| - - - - 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 |
| - - period | 0..1 | Not Used | 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 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - 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 |
| - - - 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 |
| - appointment | 0..1 | Not Used | Reference | The appointment that scheduled this encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Appointment | |||
| - - 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 |
| - period | 0..1 | Not Used | Period | The start and end time of the encounter Constraint (per-1): If present, start SHALL have a lower value than end |
| - - 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 |
| - length | 0..1 | Not Used | Duration | Quantity of time the encounter lasted (less time absent) Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (drt-1): There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. |
| - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - comparator | 0..1 | Not Used | Code | < : <= : >= : > - how to understand the value Binding (required): How the Quantity should be understood and represented. QuantityComparator |
| - - unit | 0..1 | Not Used | String | Unit representation |
| - - system | 0..1 | Not Used | Uri | System that defines coded unit form |
| - - code | 0..1 | Not Used | Code | Coded form of the unit |
| - reason | 0..1 | Not Used | CodeableConcept | Reason the encounter takes place (code) Binding (preferred): Reason why the encounter takes place. Encounter Reason Codes |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system A concept from the Care planning health issues simple reference set |
| - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system A SNOMED CT from the Care planning health issues simple reference set as defined above |
| - - - display | 1..1 | Not Used | String | Representation defined by the system The display associated with the SNOMED CT concept. This SHOULD be the preferred term |
| - - - 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 This MAY be used where a suitable coded concept is not available to the sending system |
| - diagnosis | 0..* | Not Used | BackboneElement | The list of diagnosis relevant to this encounter |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - condition | 1..1 | Not Used | Reference | Reason the encounter takes place (resource) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Procedure-1 | |||
| Not Used | CareConnect-Condition-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 |
| - - role | 0..1 | Not Used | CodeableConcept | Role that this diagnosis has within the encounter (e.g. Attendance, billing, discharge …) Binding (preferred): The type of diagnosis this condition represents DiagnosisRole |
| - - - 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 |
| - - rank | 0..1 | Not Used | positiveInt | Ranking of the diagnosis (for each role type) |
| - account | 0..* | Not Used | Reference | The set of accounts that may be used for billing for this Encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Account | |||
| - - 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 |
| - hospitalization | 0..1 | Not Used | BackboneElement | Details about the Attendance to a healthcare service |
| - - extension (AttendanceMethod) | 0..1 | Not Used | Extension-CareConnect-AdmissionMethod-1 | An extension to the Encounter resource to record how a Patient was admitted to hospital. Constraint (ext-1): Must have either extensions or value[x], not both |
| - - extension (dischargeMethod) | 0..1 | Not Used | Extension-CareConnect-DischargeMethod-1 | An extension to the Encounter resource to record the method of discharge from hospital. 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 |
| - - preAttendanceIdentifier | 0..1 | Not Used | Identifier | Pre-Attendance identifier |
| - - - 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 | Not Used | Uri | The namespace for the identifier value |
| - - - value | 1..1 | Not Used | String | The value that is unique |
| - - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - 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 | Not Used | String | Text alternative for the resource |
| - - origin | 0..1 | Not Used | Reference | The location from which the patient came before Attendance Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Location-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 |
| - - admitSource | 0..1 | Not Used | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding (preferred): The source of Addmision to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. CareConnect-SourceOfAdmission-1 |
| - - - coding | 0..1 | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system This MUST contain the value 'https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SourceOfAdmission-1' |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system This MUST contain a code from the stated ValueSet |
| - - - - display | 1..1 | Not Used | String | Representation defined by the system This MUST contain the display associated with the code from the stated ValueSet |
| - - - - 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 |
| - - reAttendance | 0..1 | Not Used | CodeableConcept | The type of hospital re-Attendance that has occurred (if any). If the value is absent, then this is not identified as a reAttendance Binding (example): The reason for re-admission of this hospitalization encounter. v2 Re-admission Indicator |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system |
| - - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 1..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 |
| - - dietPreference | 0..* | Not Used | CodeableConcept | Diet preferences reported by the patient Binding (extensible): Medical, cultural or ethical food preferences to help with catering requirements. Diet |
| - - - 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 |
| - - specialCourtesy | 0..* | Not Used | CodeableConcept | Special courtesies (VIP, board member) Binding (preferred): Special courtesies SpecialCourtesy |
| - - - 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 |
| - - specialArrangement | 0..* | Not Used | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding (preferred): Special arrangements SpecialArrangements |
| - - - 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 |
| - - destination | 0..1 | Not Used | Reference | Location to which the patient is discharged Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Location-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 |
| - - dischargeDisposition | 0..1 | Not Used | CodeableConcept | Category or kind of location after discharge Binding (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. CareConnect-DischargeDestination-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 |
| - location | 0..1 | Required | BackboneElement | List of locations where the patient has been |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - 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 |
| - - - 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 |
| - - status | 0..1 | Not Used | Code | planned : active : reserved : completed Binding (required): The status of the location. EncounterLocationStatus |
| - - period | 0..1 | Not Used | Period | Time period during which the patient was present at the location Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 |
| - serviceProvider | 0..1 | Not Used | Reference | The custodian organization of this Encounter record 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 | Not Used | String | Text alternative for the resource |
| - partOf | 0..1 | Not Used | Reference | Another Encounter this encounter is part of 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 |
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' |
| - 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 languages |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - 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 | Unique identifier |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known . identifier-use |
| - - 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 |
| - - - 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 | 0..1 | Required | Uri | The namespace for the identifier value |
| - - value | 0..1 | Required | String | The value that is unique |
| - - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - 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 ) | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - - - 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 |
| - definition | 0..* | Not Used | Reference | Instantiates protocol or definition Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | ActivityDefinition | |||
| Not Used | PlanDefinition | |||
| - - 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 |
| - basedOn | 0..* | Not Used | Reference | Request fulfilled by this communication Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Resource | |||
| - - 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 |
| - partOf | 0..* | Not Used | Reference | Part of this action Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Resource | |||
| - - 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 |
| - status | 1..1 | Not Used | Code | preparation : in-progress : suspended : aborted : completed : entered-in-error Binding (required): The status of the communication.event-status |
| - notDone | 0..1 | Not Used | Boolean | Communication did not occur |
| - notDoneReason | 0..1 | Not Used | CodeableConcept | Why communication did not occur Binding (example): Codes for the reason why a communication was not done. communication |
| - - 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 |
| - category | 0..* | Not Used | CodeableConcept | Message category Binding (example): Codes for general categories of communications such as alerts, instruction, etc. communication-category |
| - - 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 |
| - 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' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - 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 |
| - - - 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 | Not Used | Reference | Focus of message Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0..1 | Not Used | Group | ||
| 0..1 | Not Used | CareConnect-Patient-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 |
| - recipient | 0..* | Not Used | Reference | Message recipient Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0..1 | Not Used | Device | ||
| 0..1 | Not Used | Group | ||
| 0..1 | Not Used | CareConnect-Patient-1 | ||
| 0..1 | Not Used | CareConnect-Organization-1 | ||
| 0..1 | Not Used | CareConnect-Practitioner-1 | ||
| 0..1 | Not Used | CareConnect-RelatedPerson-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 |
| - topic | 0..* | Not Used | Reference | Focal resources Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Resource | |||
| - - 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 |
| - context | 0..1 | Not Used | Reference | Encounter or episode leading to message Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0..1 | Not Used | CareConnect-EpisodeOfCare-1 | ||
| 0..1 | 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 |
| - sent | 0..1 | Not Used | dateTime | When sent |
| - received | 0..1 | Not Used | dateTime | When received |
| - sender | 0..1 | Not Used | Reference | Message sender Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0..1 | Not Used | Device | ||
| 0..1 | Not Used | CareConnect-Patient-1 | ||
| 0..1 | Not Used | CareConnect-Organization-1 | ||
| 0..1 | Not Used | CareConnect-Practitioner-1 | ||
| 0..1 | Not Used | CareConnect-RelatedPerson-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 |
| - reasonCode | 0..* | Not Used | CodeableConcept | Indication for message Binding (example): Codes for describing reasons for the occurrence of a communication. clinical-findings |
| - - 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 |
| - reasonReference | 0..* | Not Used | Reference | Why was communication done? Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0..* | Not Used | CareConnect-Observation-1 | ||
| 0..* | Not Used | CareConnect-Condition-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 |
| - payload | 0..* | Not Used | BackboneElement | Message payload |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - content[x] | 1..1 | Not Used | String | Message part content |
| 0..1 | Not Used | Attachment | ||
| 0..1 | Not Used | Reference | ||
| 0..1 | Not Used | Resource | ||
| - note | 0..* | Not Used | Annotation | Comments made about the communication |
| - - 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 |
| 0..1 | Not Used | CareConnect-Patient-1 | ||
| 0..1 | Not Used | CareConnect-Practitioner-1 | ||
| 0..1 | Not Used | CareConnect-RelatedPerson-1 | ||
| 0..1 | Not Used | String | ||
| - - time | 0..1 | Not Used | dateTime | When the annotation was made |
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'“ |
| - 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 |
| - 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(s) relevant for this EpisodeOfCare |
| - - 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 | 0..1 | Required | Uri | The namespace for the identifier value |
| - - value | 0..1 | Required | String | The value that is unique |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 | Not Used | 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' |
| - statusHistory | 0..* | Not Used | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - status | 1..1 | Not Used | Code | planned : waitlist : active : onhold : finished : cancelled : entered-in-error Binding (required): The status of the episode of care. EpisodeOfCareStatus |
| - - period | 1..1 | Not Used | Period | Duration the EpisodeOfCare was in the specified status Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - 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 |
| - 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 |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - 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 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - diagnosis | 0..* | Not Used | BackboneElement | The list of diagnosis relevant to this episode of care |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - condition | 1..1 | Not Used | Reference | Conditions/problems/diagnoses this episode of care is for Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Condition-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 |
| - - role | 0..1 | Not Used | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding (preferred): The type of diagnosis this condition represents DiagnosisRole |
| - - - 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 |
| - - rank | 0..1 | Not Used | positiveInt | Ranking of the diagnosis (for each role type) |
| - 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. |
| - - 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 |
| - managingOrganization | 0..1 | Not Used | Reference | Organization that assumes care 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 | Not Used | String | Text alternative for the resource |
| - period | 0..1 | Not Used | Period | Interval during responsibility is assumed Constraint (per-1): If present, start SHALL have a lower value than end |
| - - 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 |
| - referralRequest | 0..* | Not Used | Reference | Originating Referral Request(s) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | ReferralRequest | |||
| - - 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 |
| - careManager | 0..1 | Not Used | Reference | Care manager/care co-ordinator for the patient Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 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 |
| - team | 0..* | Not Used | Reference | Other practitioners facilitating this episode of care Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-CareTeam-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 |
| - account | 0..* | Not Used | Reference | The set of accounts that may be used for billing for this EpisodeOfCare Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Account | |||
| - - 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 |
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.