The FHIR profiles used for the Pregnancy episode details List
Heading Description
The details of the pregnancy episode status.
The following FHIR profiles are used to form the Pregnancy episode details List structure:
- CareConnect-List-1
- CareConnect-Observation-1
- CareConnect-EpisodeOfCare-1
- CareConnect-Patient (Baby Patient)
The following profiles are referenced from the Patient demographics list structure:
Pregnancy episode details list Structure
Maternity data standard Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Resource Mapping | FHIR Element |
| Pregnancy identifier | Observation | code/valueBoolean |
| Local Fetal Identifier | Patient (Baby patient) | identifier (local identifier) |
| Maternity Episode Start Date | EpisodeOfCare | period.start |
| Maternity Episode End Date | EpisodeOfCare | period.end |
| Reason for late booking | unmapped | |
| Maternity Episode End Reason | unmapped |
Mapping for Pregnancy episode 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 Pregnancy episode details List |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came |
| - - value | 1..1 | Mandatory | String | The value that is unique A value for the identifier |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | current : retired : entered-in-error Binding (required): The current state of the list ListStatus The status of the list MUST contain the value 'current' |
| - mode | 1..1 | Mandatory | Code | working : snapshot : changes Binding (required): The processing mode that applies to this list ListMode The mode of the list MUST contain the value 'snapshot' |
| - title | 0..1 | Mandatory | String | Descriptive name for the list This MUST contain the value 'Pregnancy episode details' Mapping to Maternity data item = 'PSRB Heading Pregnancy episode 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 'tbc' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Pregnancy episode details' Mapping to Maternity data item = 'Pregnancy episode 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 Pregnancy episode 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 |
| - - author[x] | 0..1 | Optional | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Practitioner-1 | |||
| Optional | String | Who authored the comment on the list. | ||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Required | String | The annotation - text content |
| - entry | 0..* | Mandatory | BackboneElement | Entries in the list The entries MUST be as per the diagram for this PRSB headings list with the Observation and Patient (Baby patient) resources being the focal resources. |
| - - 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 the Observation or Patient (Baby patient) resources included in the list |
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL |
Patient Reference
The Pregnancy episode details List has a mandated subject reference to the Patient resource. This means that any exchange of the Plan and requested actions heading data must also include the Patient demographics List.
Mapping for Pregnancy episode details Observation
| > | Level 1 | Observation Resource | > | Level 2 | CareConnect-Observation-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Observation | | Measurements and simple assertions 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 (obs-7): If code is the same as a component code then the value element associated with the code SHALL NOT be present Constraint (obs-6): dataAbsentReason SHALL only be present if Observation.value[x] is not present |
||
| - 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-Observation-1' |
| - identifier | 0..* | Required | Identifier | Business Identifier for observation An identifier for this Pregnancy episode details Observation |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value The system from which the identifier came |
| - - value | 1..1 | Mandatory | String | The value that is unique The value for the identifier |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | registered : preliminary : final : amended + Binding (required): Codes providing the status of an observation. ObservationStatus This MUST contain the value 'final' |
| - code | 1..1 | Mandatory | CodeableConcept | Type of observation (code / type) Binding (example): Codes identifying names of simple observations. LOINC Codes Mapping to Digital Maternity data item='Pregnancy indicator' |
| - - coding | 0..1 | Optional | Coding | Code defined by a terminology system Slicing: Discriminator: code, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation CareConnect-ObservationType-1 |
| - - - extension (snomedCTDescriptionID) | 0..1 | Optional | 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 CodeSystem tbc |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system tbc |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system tbc |
| - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - subject | 0..1 | Optional | Reference | Who and/or what this is about Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Patient-1 | |||
| - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - effective[x] | 0..1 | Optional | dateTime | Clinically relevant time/time-period for observation |
| Optional | Period | |||
| - performer | 0..1 | Optional | Reference | Who is responsible for the observation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Practitioner-1 | |||
| - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - value[x] | Required | CodeableConcept | The system element MUST contain the identity of the terminology system Mapping to Digital Maternity data item='Reason for late booking (value)' Valueset tbc |
Mapping for Pregnancy episode 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 |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | planned : waitlist : active : onhold : finished : cancelled : entered-in-error Binding (required): The status of the episode of care. EpisodeOfCareStatus This MUST contain the value 'finished' |
| - type | 0..* | Optional | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding (example): The type of the episode of care EpisodeOfCareType |
| - - coding | 0..* | Optional | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Optional | Uri | Identity of the terminology system |
| - - - version | 0..1 | Optional | String | Version of the system - if relevant |
| - - - code | 0..1 | Optional | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Optional | String | Representation defined by the system |
| - - - userSelected | 0..1 | Optional | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - patient | 1..1 | Mandatory | Reference | The patient who is the focus of this episode of care Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the Patient who is the subject of the EpisodeOfCare. |
| Mandatory | CareConnect-Patient-1 | This is the subject of the Episode of Care.This MUST use the CareConnect patient profile. |
||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle. |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - managingOrganization | 0..1 | Required | Reference | Organization that assumes care Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Required | CareConnect-Organization-1 | |||
| - - reference | 0..1 | Required | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - period | 1..1 | Mandatory | Period | Interval during responsibility is assumed Constraint (per-1): If present, start SHALL have a lower value than end |
| - - start | 1..1 | Mandatory | dateTime | Starting time with inclusive boundary Mapping to Digital Maternity data item='Maternity episode start date' |
| - - end | 0..1 | Required | dateTime | End time with inclusive boundary, if not ongoing Mapping to Digital Maternity data item='Maternity episode end date' |
Mapping for Pregnancy episode details Baby patient
| > | Level 1 | Patient Resource | > | Level 2 | CareConnect-Patient-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Patient | | Information about an individual or animal receiving health care services 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-Patient-1' |
| - identifier | 1..* | Mandatory | Identifier | An identifier for this patient Slicing: Discriminator: system, Ordering: false, Rules: Open at End An identifier for this Pregnancy episode details Baby Patient Mapping to Digital Maternity data item = 'Local identifier' |
| - - use | 0..1 | Optional | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - type | 0..1 | Optional | 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 |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value |
| - - value | 1..1 | Mandatory | String | The value that is unique |
| - - period | 0..1 | Optional | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - assigner | 0..1 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - active | 0..1 | Optional | Boolean | Whether this patient’s record is in active use Default Value: true |
| - name | 1..* | Mandatory | HumanName | A name associated with the patient Slicing: Discriminator: use, Ordering: false, Rules: Open at End |
| - name (official) | 1..1 | Mandatory | HumanName | A name associated with the patient |
| - - use | 1..1 | Mandatory | Code | usual : official : temp : nickname : anonymous : old : maiden The value attribute MUST contain the value 'official' Binding (required): The use of a human name CareConnect-NameUse-1 |
| - - text | 0..1 | Optional | String | Text representation of the full name |
| - - family | 1..1 | Mandatory | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Optional | String | Given names (not always ‘first’). Includes middle names |
| - - prefix | 0..* | Optional | String | Parts that come before the name |
| - - suffix | 0..* | Optional | String | Parts that come after the name |
| - - period | 0..1 | Optional | Period | Time period when name was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Optional | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Optional | dateTime | End time with inclusive boundary, if not ongoing |
| - name (other) | 0..* | Optional | HumanName | A name associated with the patient |
| - - use | 1..1 | Mandatory | Code | usual : official : temp : nickname : anonymous : old : maiden Binding (required): The use of a human name CareConnect-NameUse-1 |
| - - text | 0..1 | Optional | String | Text representation of the full name |
| - - family | 0..1 | Optional | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Optional | String | Given names (not always ‘first’). Includes middle names |
| - - prefix | 0..* | Optional | String | Parts that come before the name |
| - - suffix | 0..* | Optional | String | Parts that come after the name |
| - - period | 0..1 | Optional | Period | Time period when name was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Optional | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Optional | dateTime | End time with inclusive boundary, if not ongoing |
| - gender | 0..1 | Optional | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes. CareConnect-AdministrativeGender-1 |
| - deceased[x] | 0..1 | Optional | Boolean | Indicates if the individual is deceased or not |
| Optional | dateTime | |||
| - multipleBirth[x] | 0..1 | Optional | Boolean | Whether patient is part of a multiple birth |
| Optional | Integer |
Mapping for Pregnancy episode details Location
The Pregnancy episode details List has reference(s) to the Location resource. This means that any exchange of the plan and requested actions details heading data must also include the Location Details