The FHIR profiles used for the Birth Details Event Message Bundle
The following FHIR profiles are used to form the Birth Details Event Message Bundle:
- NHSD-Bundle-1
- NHSD-MessageHeader-1
- CareConnect-Organization-1
- CareConnect-HealthcareService-1
- CareConnect-Patient-1
- CareConnect-Encounter-1
- CareConnect-Condition-1
- CareConnect-Observation-1
- CareConnect-Procedure-1
- CareConnect-Location-1
Birth Details Bundle structure
Birth Details Event data item mapping to FHIR profiles
Mapping for Bundle
How to populate the Bundle instance to conform to the profiles below:
| Level 1 | Bundle Resource | Level 2 | None | Level 3 | NHSD-Bundle-1 Profile |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Maternity-Record Implementation |
|---|---|---|---|---|
| Bundle | | Contains a collection of resources Constraint (bdl-7): FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId Constraint (bdl-9): A document must have an identifier with a system and a value Constraint (bdl-3): Entry.Request Only For Some Types Of Bundles Constraint (bdl-4): Entry.Response Only For Some Types Of Bundles Constraint (bdl-1): Total Only When A Search Or History Constraint (bdl-2): Entry.Search Only When A Search |
||
| - id | 0..1 | Mandatory | Id | Must contain a UUID to identify the instance of a bundle |
| - meta | 0..1 | Mandatory | Meta | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/NHSD-Bundle-1'. |
| - type | 1..1 | Mandatory | Code | document : message : transaction : transaction-response : batch : batch-response : history : searchset : collection Binding (required): Indicates the purpose of a bundle - how it was intended to be used. See FHIR STU3 for further info The value attribute of the code element MUST contain the fixed value: 'message'. |
| - entry | 1..* | Mandatory | BackboneElement | Entry in the bundle - will have a resource, or information Constraint (bdl-8): fullUrl cannot be a version specific reference Constraint (bdl-5): Must Be A Resource Unless There’S A Request Or Response |
| - - fullUrl | 0..1 | Mandatory | Uri | Absolute URL for resource (server address, or UUID/OID). This MUST be a UUID prefixed by urn:uuid : |
| - - resource | 1..1 | Mandatory | Resource | A resource in the bundle. This MUST be to the MessageHeader resource profiled as NHSD-MessageHeader-1. See Mapping for MessageHeader for further info. |
Mapping for MessageHeader
How to populate the MessageHeader instance to conform to the profiles below:
| Level 1 | MessageHeader Resource | Level 2 | None | Level 3 | NHSD-MessageHeader-1 Profile |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Maternity-Record Implementation |
|---|---|---|---|---|
| MessageHeader | | A resource that describes a message that is exchanged between systems 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 | 1..1 | Mandatory | Id | Logical id of this artifact. This MUST be a UUID. |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource. The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/NHSD-MessageHeader-1' |
| - extension (messageEventType) | 1..1 | Mandatory | Extension-Maternity-Record-MessageEventType-1 | The url attribute of the extension element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-Maternity-Record-MessageEventType-1' and be populated as specified here. |
| - event | 0..* | Mandatory | Coding | Code for the event this message represents - Binding (required): The type of Child Health Event. |
| - - system | 1..1 | Mandatory | Uri | MUST contain the value: 'https://fhir.nhs.uk/STU3/CodeSystem/Maternity-Record-ChildHealthEventType-1' |
| - - code | 0..1 | Mandatory | Code | MUST contain the value 'CH005' |
| - - display | 1..1 | Mandatory | String | MUST contain the value 'Birth Details' |
| - timestamp | 1..1 | Mandatory | Instant | Time that the message was sent |
| - source | 1..1 | Mandatory | BackboneElement | Message source application identified using an ASID |
| - - endpoint | 1..1 | Mandatory | Uri | Actual message source address or id Must contain the ASID of the sending system prefixed by urn:nhs:addressing:asid:for example urn:nhs:addressing:asid:477121000325. |
| - responsible | 1..1 | Mandatory | Reference | Final responsibility for event Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Organization-1 | The responsible organization carried in the Organizaion resource in the bundle. This MUST be to the Organization resource profiled as CareConnect-Organization-1" See mapping for Organization for further info. | ||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URLMUST contain a UUID prefixed by urn:uuid: |
| - focus | 1..1 | Mandatory | Reference | The actual content of the message Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Encounter-1 | The focus resource in the bundle. This MUST be to the encounter resource profiled as CareConnect-Encounter-1. See mapping for encounter for further info | ||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL.MUST contain a UUID prefixed by urn:uuid: |
Mapping for Encounter
How to populate the Encounter instance to conform to the profiles below:
| Level 1 | Encounter Resource | Level 2 | CareConnect-Encounter-1 | Level 3 | None |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Maternity-Record 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 |
||
| - meta | 0..1 | Mandatory | Meta | The value attribute of the profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Encounter-1 |
| - identifier | 0..1 | Mandatory | Identifier | Identifier(s) by which this encounter is known. |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value. MUST contain the value 'https://tools.ietf.org/html/rfc4122'. |
| - - value | 1..1 | Mandatory | String | The value that is unique. MUST contain a UUID |
| - status | 1..1 | Mandatory | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled. Binding (required): Current state of the encounter. See FHIR STU3 for further info MUST contain the value 'completed' |
| - type | 0..* | Mandatory | CodeableConcept | Code defined by a terminology system Binding (required): The type of Child Health encounter |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - system | 1..1 | Mandatory | Uri | Identity of the terminology system. MUST contain the value 'https://fhir.nhs.uk/STU3/ValueSet/Maternity-Record-ChildHealthEncounterType-1' |
| - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system. MUST contain the value '003'. |
| - - display | 1..1 | Mandatory | String | Representation defined by the system. MUST contain the value 'Birth'. |
| - subject | 1..1 | Mandatory | Reference | The patient present at the encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided. |
| Mandatory | CareConnect-Patient-1 | A patient resource in the bundle.This MUST be to the Patient resource profiled as CareConnect-Patient-1 See Mapping for Patient for further info. | ||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL a reference to the Patient resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'. |
| 0.1 | Mandatory | CareConnect-NHSD-Location | A location resource in the bundle.This MUST be to the Location resource profiled as CareConnect-NHSD-Location-1 See Mapping for Location for further info. | |
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL a reference to the location resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'. |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
| - - serviceProvider | 1..1 | Mandatory | Reference | The custodian organization of this Encounter record Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Organization-1 | An organization resource in the bundle.This MUST be to the Organization resource profiled as CareConnect-Organization-1 See mapping for Organization for further info | ||
| - - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL a reference to the Organization resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'. |
| - - - display | 0..1 | Optional | String | Text alternative for the resource |
Mapping for Patient
How to populate the Patient instance to conform to the profiles below:
| 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 XXX Implementation |
| Patient | | Information about an individual 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 |
||
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource. The profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Patient-1 |
| - identifier | 0..* | Mandatory | Identifier | An identifier for this patient Slicing: Discriminator: system, Ordering: false, Rules: Open at End |
| - - identifier (nhsNumber) | 0..1 | Mandatory | Identifier | The patient’s NHS number |
| - - extension (nhsNumber VerificationStatus) |
1..1 | Mandatory | NHSNumberVerificationStatus-1 | NHS number verification status Constraint (ext-1): Must have either extensions or value[x], not both See mapping for nhsNumberVerificationStatus for further info |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
| - - value | 1..1 | Mandatory | String | The value that is unique. MUST contain a valid NHS Number Maps to data set item NHS Number |
| - 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. Binding (required): The use of a human name. See FHIR STU3 for further info MUST contain the value 'official' |
| - - family | 1..1 | Mandatory | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Mandatory | String | Given names (not always ‘first’). Includes middle names |
| - gender | 0..1 | Mandatory | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes.See FHIR STU3 for further info |
| - birthDate | 0..1 | Mandatory | Date | The date of birth for the individual |
| - - extension (patient-birthTime) | 0..1 | Mandatory | 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 See mapping for patient-birthTime for further info. |
| - address | 0..* | Mandatory | Address | Addresses for the individual |
| - - use | 0..1 | Mandatory | Code | home : work : temp : old - purpose of this address Binding (required): The use of an address See FHIR STU3 for further info |
| - - line | 0..* | Mandatory | String | Street name, number, direction & P.O. Box etc. |
| - - city | 0..1 | Mandatory | String | Name of city, town etc. |
| - - postalCode | 0..1 | Mandatory | String | Postal code for area |
| - multipleBirth[x] | 0..1 | Mandatory | Boolean : Integer | Whether patient is part of a multiple birth Use Boolean datatype and value false for non multiple births. Use Integer datatype with value of number of births for multiple births |
| Maternity-Record Data Item | FHIR resource element | Mandatory/Required/Optional |
|---|---|---|
| Location of Birth | CareConnect-Maternity-Record-Delivery-Location-1.identifier (ODS Site Code) | Required |
| Delivery Place Type Code | CareConnect-Maternity-Record-Delivery-Location-1.physicalType | Mandatory |
| Birth Order | CareConnect-Maternity-Record-Patient-1.multipleBirthInteger | Mandatory |
| Length of Gestation at Birth | CareConnect-Maternity-Record-LengthOfGestation-Observation-1.valueQuantity | Mandatory |
| Number of Births in confinement | CareConnect-Maternity-Record-NumberOfBirths-Observation-1.valueQuantity | Mandatory |
| Problems during Delivery | CareConnect-Maternity-Record-ProblemDuringDelivery-Condition-1.code | Required |
| Physical Problems detected at Birth | CareConnect-Maternity-Record-PhysicalProblemAtBirth-Condition-1.code | Required |
| Neonatal Resuscitation Method | CareConnect-Maternity-Record-NeonatalResuscitationMethod-Procedure-1.code | Required |
| Date and Time of Birth | CareConnect-Maternity-Record-Patient-1.birthDate (with patient-BirthTime extension) | Mandatory |
| Type of Delivery | CareConnect-Maternity-Record-FinalDeliveryType-Procedure-1.code | Mandatory |
| Attempted Type of Delivery | CareConnect-Maternity-Record-AttemptedDeliveryType-Condition-1.code | Required |
| Onset of Spontaneous Respiration | CareConnect-Maternity-Record-SpontaneousRespirationOnset-Observation-1.component | Optional |
| APGAR Score (1 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Mandatory |
| APGAR Score (5 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Mandatory |
| APGAR Score (10 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Optional |
| Put To Breast | CareConnect-Maternity-Record-PutToBreastIndicator-Observation-1.code | Required |
| Identical Twin Indicator | CareConnect-Maternity-Record-IdenticalTwinIndicator-Observation-1.code | Optional |