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' |
| - 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 Pregnancy episode 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 |
| - - value | 1..1 | Mandatory | String | The value that is unique A value for the identifier |
| - - 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 | 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' |
| - - - 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 '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' |
| - - - 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 Pregnancy episode 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 |
| 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 |
| - 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 | Optional | 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 | |||
| 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. |
| - - 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 the Observation or Patient (Baby patient) resources included in the list |
| Not Used | Resource | |||
| - - - reference | 0..1 | Mandatory | 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 |
| - 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 |
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' |
| - 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 for observation An identifier for this Pregnancy episode details Observation |
| - - 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 | 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 |
| - - 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 | Optional | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Optional | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - basedOn | 0..* | Not Used | Reference | Fulfills plan, proposal or order. Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CarePlan | |||
| Not Used | DeviceRequest | |||
| Not Used | ImmunizationRecommendation | |||
| Not Used | NutritionOrder | |||
| Not Used | ProcedureRequest | |||
| Not Used | ReferralRequest | |||
| Not Used | CareConnect-MedicationRequest-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 | registered : preliminary : final : amended + Binding (required): Codes providing the status of an observation. ObservationStatus This MUST contain the value 'final' |
| - category | 0..* | Not Used | CodeableConcept | Classification of type of observation Binding (preferred): Codes for high level observation categories. Observation Category 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 |
| - 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 |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - 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 |
| Not Used | Group | |||
| Not Used | Device | |||
| Optional | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Location-1 | |||
| - - reference | 0..1 | Optional | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Optional | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Optional | String | Text alternative for the resource |
| - context | 0..1 | Not Used | Reference | Healthcare event during which this observation is made Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | EpisodeOfCare | |||
| 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 |
| - effective[x] | 0..1 | Optional | dateTime | Clinically relevant time/time-period for observation |
| Optional | Period | |||
| - issued | 0..1 | Not Used | Instant | Date/Time this was made available |
| - 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 |
| Not Used | RelatedPerson | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Organization-1 | |||
| 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] | 0..1 | Not Used | Quantity | Actual result Constraint (qty-3): If a code for the unit is present, the system SHALL also be present |
| - 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 |
|
| - value[x] | Not Used | String | ||
| - value[x] | Not Used | Boolean | ||
| - value[x] | Not Used | Range | ||
| - value[x] | Not Used | Ratio | ||
| - value[x] | Not Used | SampledData | ||
| - value[x] | Not Used | Attachment | ||
| - value[x] | Not Used | Time | ||
| - value[x] | Not Used | dateTime | ||
| - value[x] | Not Used | Period | ||
| - dataAbsentReason | 0..1 | Not Used | CodeableConcept | Why the result is missing Binding (extensible): Codes specifying why the result (Observation.value[x]) is missing. Observation Value Absent Reason |
| - - 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 |
| - interpretation | 0..1 | Not Used | CodeableConcept | High, low, normal, etc. Binding (extensible): Codes identifying interpretations of observations. Observation Interpretation 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 |
| - comment | 0..1 | Not Used | String | Comments about result |
| - bodySite | 0..1 | Not Used | CodeableConcept | Observed body part Binding (example): Codes describing anatomical locations. May include laterality. SNOMED CT Body Structures |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: code, 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 |
| - - - 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 |
| - method | 0..1 | Not Used | CodeableConcept | How it was done Binding (example): Methods for simple observations. Observation Methods |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: code, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system Binding (preferred): A code from SNOMED Clinical Terminology UK CareConnect-ObservationMethod-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 | Not Used | Uri | Identity of the terminology system |
| - - - 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 |
| - specimen | 0..1 | Not Used | Reference | Specimen used for this observation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Specimen | |||
| - - 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 |
| - device | 0..1 | Not Used | Reference | (Measurement) Device Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Device | |||
| Not Used | DeviceMetric | |||
| - - 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 |
| - referenceRange | 0..* | Not Used | BackboneElement | Provides guide for interpretation Constraint (obs-3): Must have at least a low or a high or text |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - low | 0..1 | Not Used | Quantity ( SimpleQuantity ) | Low Range, if relevant Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity |
| - - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - - 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 |
| - - high | 0..1 | Not Used | Quantity ( SimpleQuantity ) | High Range, if relevant Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity |
| - - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - - 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 |
| - - type | 0..1 | Not Used | CodeableConcept | Reference range qualifier Binding (extensible): Code for the meaning of a reference range. Observation Reference Range Meaning 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 |
| - - appliesTo | 0..* | Not Used | CodeableConcept | Reference range population Binding (example): Codes identifying the population the reference range applies to. Observation Reference Range Applies To 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 |
| - - age | 0..1 | Not Used | Range | Applicable age range, if relevant Constraint (rng-2): If present, low SHALL have a lower value than high |
| - - - low | 0..1 | Not Used | Quantity ( SimpleQuantity ) | Low limit Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity |
| - - - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - - - 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 |
| - - - high | 0..1 | Not Used | Quantity ( SimpleQuantity ) | High limit Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity |
| - - - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - - - 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 |
| - - text | 0..1 | Not Used | String | Text based reference range in an observation |
| - related | 0..* | Not Used | BackboneElement | Resource related to this observation |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - type | 0..1 | Not Used | Code | has-member : derived-from : sequel-to : replaces : qualified-by : interfered-by Binding (required): Codes specifying how two observations are related. ObservationRelationshipType |
| - - target | 1..1 | Not Used | Reference | Resource that is related to this one Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | QuestionnaireResponse | |||
| Not Used | Sequence | |||
| Not Used | CareConnect-Observation-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 |
| - component | 0..* | Not Used | BackboneElement | Component results |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - code | 1..1 | Not Used | CodeableConcept | Type of component observation (code / type) Binding (example): Codes identifying names of simple observations. LOINC Codes |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: code, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Not Used | 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 | 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 |
| - - - 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 |
| - value[x] | 0..1 | Not Used | Quantity | Actual component result Constraint (qty-3): If a code for the unit is present, the system SHALL also be present |
| - value[x] | Not Used | CodeableConcept | ||
| - value[x] | Not Used | String | ||
| - value[x] | Not Used | Range | ||
| - value[x] | Not Used | Ratio | ||
| - value[x] | Not Used | SampledData | ||
| - value[x] | Not Used | Attachment | ||
| - value[x] | Not Used | Time | ||
| - value[x] | Not Used | dateTime | ||
| - value[x] | Not Used | Period | ||
| - dataAbsentReason | 0..1 | Not Used | CodeableConcept | Why the component result is missing Binding (extensible): Codes specifying why the result (Observation.value[x]) is missing. Observation Value Absent Reason |
| - - 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 |
| - interpretation | 0..1 | Not Used | CodeableConcept | High, low, normal, etc. Binding (extensible): Codes identifying interpretations of observations. Observation Interpretation 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 |
| - referenceRange | 0..* | Not Used | see Observation.referenceRange | Provides guide for interpretation of component result |
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' |
| - 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 | 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' |
| - 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 | 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 |
| - 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. |
||
| - - 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' |
| - 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 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' |
| - 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 (ethnicCategory) | 0..1 | Not Used | Extension-CareConnect-EthnicCategory-1 | Ethnic category Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (religiousAffiliation) | 0..1 | Not Used | Extension-CareConnect-ReligiousAffiliation-1 | Religious affiliation Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (patient-cadavericDonor) | 0..1 | Not Used | patient-cadavericDonor | Flag indicating whether the patient authorized the donation of body parts after death Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (residentialStatus) | 0..1 | Not Used | Extension-CareConnect-ResidentialStatus-1 | The residential status of the patient Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (treatmentCategory) | 0..1 | Not Used | Extension-CareConnect-TreatmentCategory-1 | The treatment category for this patient Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (nhsCommunication) | 0..* | Not Used | Extension-CareConnect-NHSCommunication-1 | NHS communication preferences for a resource Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (birthPlace) | 0..1 | Not Used | birthPlace | Birth Place: The registered place of birth of the patient. Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (nominatedPharmacy) | 0..1 | Not Used | Extension-CareConnect-NominatedPharmacy-1 | A patient’s nominated pharmacy Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (deathNotificationStatus) | 0..1 | Not Used | Extension-CareConnect-DeathNotificationStatus-1 | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) 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 | 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' |
| - identifier (nhsNumber) | 0..1 | Not Used | Identifier | The patient’s NHS number |
| - - extension (nhsNumberVerificationStatus) | 1..1 | Not Used | Extension-CareConnect-NHSNumberVerificationStatus-1 | NHS number verification status Constraint (ext-1): Must have either extensions or value[x], not both |
| - - 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 |
| - telecom | 0..* | Not Used | ContactPoint | A contact detail for the individual Constraint (cpt-2): A system is required if a value is provided. |
| - - system | 1..1 | Not Used | Code | phone : fax : email : pager : url : sms : other Binding (required): Telecommunications form for contact point ContactPointSystem |
| - - value | 1..1 | Not Used | String | The actual contact point details |
| - - use | 0..1 | Not Used | Code | home : work : temp : old : mobile - purpose of this contact point Binding (required): Use of contact point ContactPointUse |
| - - rank | 0..1 | Not Used | positiveInt | Specify preferred order of use (1 = highest) |
| - - period | 0..1 | Not Used | Period | Time period when the contact point was/is in 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 |
| - gender | 0..1 | Optional | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes. CareConnect-AdministrativeGender-1 |
| - birthDate | 0..1 | Not Used | Date | The date of birth for the individual |
| - - extension (patient-birthTime) | 0..1 | Not Used | patient-birthTime | The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Constraint (ext-1): Must have either extensions or value[x], not both |
| - deceased[x] | 0..1 | Optional | Boolean | Indicates if the individual is deceased or not |
| Optional | dateTime | |||
| - address | 0..* | Not Used | Address | Addresses for the individual |
| - - use | 0..1 | Not Used | Code | home : work : temp : old - purpose of this address Binding (required): The use of an address AddressUse |
| - - type | 0..1 | Not Used | Code | postal : physical : both Binding (required): The type of an address (physical / postal) AddressType |
| - - text | 0..1 | Not Used | String | Text representation of the address |
| - - line | 0..* | Not Used | String | Street name, number, direction & P.O. Box etc. |
| - - city | 0..1 | Not Used | String | Name of city, town etc. |
| - - district | 0..1 | Not Used | String | District name (aka county) |
| - - state | 0..1 | Not Used | String | Sub-unit of country (abbreviations ok) |
| - - postalCode | 0..1 | Not Used | String | Postal code for area |
| - - country | 0..1 | Not Used | String | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| - - period | 0..1 | Not Used | Period | Time period when address was/is in 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 |
| - maritalStatus | 0..1 | Not Used | CodeableConcept | Marital (civil) status of a patient Binding (required): The domestic partnership status of a person. CareConnect-MaritalStatus-1 |
| - - coding | 1..1 | Not Used | Coding | Code defined by a terminology system |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system |
| - - - 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 |
| - multipleBirth[x] | 0..1 | Optional | Boolean | Whether patient is part of a multiple birth |
| Optional | Integer | |||
| - photo | 0..* | Not Used | Attachment | Image of the patient Constraint (att-1): It the Attachment has data, it SHALL have a contentType |
| - - contentType | 0..1 | Not Used | Code | Mime type of the content, with charset etc. Binding (required): The mime type of an attachment. Any valid mime type is allowed. MimeType |
| - - language | 0..1 | Not Used | Code | Human language of the content (BCP-47) Binding (extensible): A human language. Common Languages |
| - - data | 0..1 | Not Used | base64Binary | Data inline, base64ed |
| - - url | 0..1 | Not Used | Uri | Uri where the data can be found |
| - - size | 0..1 | Not Used | unsignedInt | Number of bytes of content (if url provided) |
| - - hash | 0..1 | Not Used | base64Binary | Hash of the data (sha-1, base64ed) |
| - - title | 0..1 | Not Used | String | Label to display in place of the data |
| - - creation | 0..1 | Not Used | dateTime | Date attachment was first created |
| - contact | 0..* | Not Used | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraint (pat-1): SHALL at least contain a contact’s details or a reference to an organization |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - relationship | 0..* | Not Used | CodeableConcept | The kind of relationship Binding (extensible): The nature of the relationship between a patient and a contact person for that patient. v2 Contact Role |
| - - - 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 |
| - - name | 1..1 | Not Used | HumanName | A name associated with the contact person |
| - - - use | 1..1 | Not Used | Code | usual : official : temp : nickname : anonymous : old : maiden Binding (required): The use of a human name NameUse |
| - - - text | 0..1 | Not Used | String | Text representation of the full name |
| - - - family | 0..1 | Not Used | String | Family name (often called ‘Surname’) |
| - - - given | 0..* | Not Used | String | Given names (not always ‘first’). Includes middle names |
| - - - prefix | 0..* | Not Used | String | Parts that come before the name |
| - - - suffix | 0..* | Not Used | String | Parts that come after the name |
| - - - period | 0..1 | Not Used | 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 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - telecom | 0..* | Not Used | ContactPoint | A contact detail for the person Constraint (cpt-2): A system is required if a value is provided. |
| - - - system | 0..1 | Not Used | Code | phone : fax : email : pager : url : sms : other Binding (required): Telecommunications form for contact point ContactPointSystem |
| - - - value | 0..1 | Not Used | String | The actual contact point details |
| - - - use | 0..1 | Not Used | Code | home : work : temp : old : mobile - purpose of this contact point Binding (required): Use of contact point ContactPointUse |
| - - - rank | 0..1 | Not Used | positiveInt | Specify preferred order of use (1 = highest) |
| - - - period | 0..1 | Not Used | Period | Time period when the contact point was/is in 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 |
| - - address | 0..1 | Not Used | Address | Address for the contact person |
| - - use | 0..1 | Not Used | Code | home : work : temp : old - purpose of this address Binding (required): The use of an address AddressUse |
| - - type | 0..1 | Not Used | Code | postal : physical : both Binding (required): The type of an address (physical / postal) AddressType |
| - - text | 0..1 | Not Used | String | Text representation of the address |
| - - line | 0..* | Not Used | String | Street name, number, direction & P.O. Box etc. |
| - - city | 0..1 | Not Used | String | Name of city, town etc. |
| - - district | 0..1 | Not Used | String | District name (aka county) |
| - - state | 0..1 | Not Used | String | Sub-unit of country (abbreviations ok) |
| - - postalCode | 0..1 | Not Used | String | Postal code for area |
| - - country | 0..1 | Not Used | String | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| - - period | 0..1 | Not Used | Period | Time period when address was/is in 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 |
| - - gender | 0..1 | Not Used | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes. CareConnect-AdministrativeGender-1 |
| - - organization | 0..1 | Not Used | Reference | Organization that is associated with the contact 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 | The period during which this contact person or organization is valid to be contacted relating to this patient 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 |
| - generalPractitioner | 0..* | Not Used | Reference | Patient’s nominated primary care provider Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-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 |
| - managingOrganization | 0..1 | Not Used | Reference | Organization that is the custodian of the patient 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 |
| - link | 0..* | Not Used | BackboneElement | Link to another patient resource that concerns the same actual person |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - other | 1..1 | Not Used | Reference | The other patient or related person resource that the link refers to Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | RelatedPerson | |||
| 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 |
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